Update FAQ, guidelines and rules

The new syntax (though not all functionality is yet finished) of
mkiocccentry does not match what was in the FAQ, guidelines and rules.

Also added an important reminder to use v7 format with tarballs as not
doing so can reveal who you are which would break the rules. This is
mentioned in the rules and guidelines, showing how to create such a
tarball.

More work does have to be done with these two things however.
This commit is contained in:
Cody Boone Ferguson committed 2025-01-30 11:43:00 -08:00
1 parent 16c5ca3896
commit db6fd9ab66
6 files changed
+93 -82

No files matched your search

+25 -23
View File
@@ -55,7 +55,7 @@ Jump to: [top](#)
<p class="leftbar">
These [IOCCC rules](rules.html) are version **28.18 2025-01-24**.
These [IOCCC rules](rules.html) are version **28.19 2025-01-30**.
</p>
<p class="leftbar">
@@ -809,19 +809,6 @@ issues
page](https://github.com/ioccc-src/mkiocccentry/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D+%3Ctitle%3E).
</p>
<p class="leftbar">
You submission may have additional files, however the filenames of those additional files **MUST**:
</p>
* <p class="leftbar">Be less than **100** characters in length.</p>
* <p class="leftbar">Match the regular expression:
`^[0-9A-Za-z][0-9A-Za-z._+-]*$`</p>
<p class="leftbar">
The `mkiocccentry(1)` tool will not package any files that do not meet
those requirements.
</p>
<p class="leftbar">
The `Makefile` **MUST** be a **non**-empty file in **[GNU
Makefile](https://www.gnu.org/software/make/manual/make.html)** form. See the
@@ -883,9 +870,9 @@ repo](https://github.com/ioccc-src/mkiocccentry).
</p>
<p class="leftbar">
Your entry may **NOT** have subdirectories. However, you can provide files that
are in different directories as `mkiocccentry(1)` will copy them to the work
directory (see the [guidelines](guidelines.html) for more details).
Your entry may have subdirectories, depending on the depth and total length of
the filenames. Certain directories like `.git`, `RCCS`, `CVS` and `.svn` are
skipped. For more information, see the [guidelines](guidelines.html).
</p>
<p class="leftbar">
@@ -893,7 +880,7 @@ Filenames in your entry (that is, not including the files generated by the
`mkiocccentry(1)` tool or the tools it or any other tool invokes) **MUST**:
</p>
* <p class="leftbar">Be less than **100** characters in length</p>
* <p class="leftbar">Be <= **38** characters in length</p>
* <p class="leftbar">**NOT** have a **`/`** (excluding the entry directory that
the `mkiocccentry(1)` tool generates).</p>
* <p class="leftbar">**NOT** contain a path component of: **`.`** (that is, with
@@ -902,12 +889,14 @@ the exception of files generated by `mkiocccentry(1)` itself, it must have
* <p class="leftbar">**NOT** contain a path component of: **`..`** (that is,
**NO** **`..`**).</p>
* <p class="leftbar">Match the regular expression
`^[0-9A-Za-z][0-9A-Za-z._+-]*$` (again, excluding files generated by
`^[0-9A-Za-z]+[0-9A-Za-z_+.-]*$` (again, excluding files generated by
`mkiocccentry(1)`).</p>
* <p class="leftbar">**NOT** be a directory depth > 4.</p>
* <p class="leftbar">**NOT** have a total path length > 99 characters.</p>
<p class="leftbar">
Additionally, the tarball **MUST** have the following files (generated
by the `mkiocccentry(1)` tool):
Additionally, the submission tarball created by `mkiocccentry(1)` **MUST** have
the following files (generated by the `mkiocccentry(1)` tool):
</p>
* <p class="leftbar">`.auth.json` which contains information about the author or
@@ -959,7 +948,10 @@ if you need to include more files.
<p class="leftbar">
If you do include a tarball that takes your extra files count over the maximum,
you **MUST** explain this in your `remarks.md` file!
you **MUST** explain this in your `remarks.md` file! **PLEASE** do not include a
tarball with extra files for a test-suite; instead mention in your remarks that
you have extra files for a test-suite that can be included should your
submission win.
</p>
<p class="leftbar">
@@ -970,9 +962,19 @@ created!
<p class="leftbar">
Tarballs **MUST** only create files and directories _under them_. They may
**NOT** contain absolute paths (paths that start with `/`)!
**NOT** contain absolute paths (paths that start with `/`)! `txzchk` only checks
the submission tarball so you must verify these details yourself.
</p>
<p class="leftbar">
Make **SURE** your tarball does not reveal who you are! The `mkiocccentry(1)`
tool uses the v7 format. For instance you might try:
</p>
``` <!---sh-->
tar --format=v7 -cJf foo.txz directory
```
<hr style="width:50%;text-align:left;margin-left:0">