From 68b9b5983cdca9175a43c1fff78a317e2fe97dec Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Thu, 30 Jan 2025 12:10:38 -0800 Subject: [PATCH] Break up text about required files in guidelines This should (hopefully) make it easier to read. --- next/guidelines.html | 36 ++++++++++++++++++++++++------------ next/guidelines.md | 39 +++++++++++++++++++++++++++------------ 2 files changed, 51 insertions(+), 24 deletions(-) diff --git a/next/guidelines.html b/next/guidelines.html index 4bb161544..0903d2bde 100644 --- a/next/guidelines.html +++ b/next/guidelines.html @@ -823,20 +823,32 @@ are considered more portable. The maximum total number of files that may be submitted has changed to 39 files. However, of those files, 5 are mandatory (prog.c, Makefile, remarks.md and the two JSON files generated by mkiocccentry(1), .info.json and -.auth.json). Additionally, three of the files in the limit MUST be -specific file(name)s: the OPTIONAL submission files, which are prog.alt.c, -try.sh and try.alt.sh, or else they WILL count as an extra file. Of -course, if you use the optional filenames without the files being their -intended, that would be an abuse of rules. -For more details on the optional files, see the -FAQ on the “try.sh script system” -and the -FAQ on “alt code”. +.auth.json). +

+

+Additionally, three of the files, if included, MUST be +specific file(name)s and in the top level directory, or they will be counted as +an extra file, not an optional file. +

+

+In particular, any file that is not prog.c, Makefile, remarks.md, +try.sh, prog.alt.c or try.alt.sh will be counted as an extra file, and if +try.sh, prog.alt.c or try.alt.sh are not in the top level directory they +will also be counted as an extra file. The .info.json and .auth.json files +are not counted as extra files but are required.

In other words, the actual amount of EXTRA files is 31.

+Of course, if you use the optional filenames without +the files being our intended use, in order to get past the file limit, that +would be an abuse of rules. For more details on the optional files, see the +FAQ on the “try.sh script system” +and the +FAQ on “alt code”. +

+

If you do need to include more files, you may do so by including as an extra file, a tarball. This does NOT have to pass txzchk(1) tests; only the submission tarball must pass the txzchk(1) tests. See the txzchk @@ -847,9 +859,9 @@ If you DO include a tarball, and the build process or the progr said tarball(s), the make clobber rule MUST remove them.

-IMPORTANT REMINDER: make SURE your tarball DOES NOT reveal who you are! -The mkiocccentry(1) tool creates v7 format tarballs to prevent this. You can -do so like: +IMPORTANT REMINDER: make SURE your tarball does NOT reveal who you are! +The mkiocccentry(1) tool creates a v7 format tarball to prevent this. You can +do the same like: 

    tar --format=v7 -cJf foo.txz directory

diff --git a/next/guidelines.md b/next/guidelines.md index 3566d5b17..d8aa7f03c 100644 --- a/next/guidelines.md +++ b/next/guidelines.md @@ -493,21 +493,36 @@ Jump to: [top](#) The maximum total number of files that may be submitted has changed to 39 files. However, of those files, 5 are mandatory (`prog.c`, `Makefile`, `remarks.md` and the two JSON files generated by `mkiocccentry(1)`, `.info.json` and -`.auth.json`). Additionally, three of the files in the limit **MUST** be -specific file(name)s: the **OPTIONAL** submission files, which are `prog.alt.c`, -`try.sh` and `try.alt.sh`, or else they **WILL** count as an extra file. Of -course, if you use the optional filenames without the files being their -intended, that would be an abuse of rules. -For more details on the optional files, see the -FAQ on the "[try.sh script system](../faq.html#try_script)" -and the -FAQ on "[alt code](../faq.html#alt_code)". +`.auth.json`). +

+ +

+Additionally, three of the files, if included, **MUST** be +specific file(name)s and in the top level directory, or they will be counted as +an extra file, not an optional file. +

+ +

+In particular, any file that is not `prog.c`, `Makefile`, `remarks.md`, +`try.sh`, `prog.alt.c` or `try.alt.sh` will be counted as an extra file, and if +`try.sh`, `prog.alt.c` or `try.alt.sh` are not in the top level directory they +will also be counted as an extra file. The `.info.json` and `.auth.json` files +are not counted as extra files but are required.

In other words, the actual amount of **EXTRA** files is 31.

+

+Of course, if you use the optional filenames without +the files being our intended use, in order to get past the file limit, that +would be an abuse of rules. For more details on the optional files, see the +FAQ on the "[try.sh script system](../faq.html#try_script)" +and the +FAQ on "[alt code](../faq.html#alt_code)". +

+

If you do need to include more files, you may do so by including as an extra file, a tarball. This does **NOT** have to pass `txzchk(1)` tests; only the @@ -521,9 +536,9 @@ said tarball(s), the make `clobber` rule **MUST** remove them.

-**IMPORTANT REMINDER**: make **SURE** your tarball DOES **NOT** reveal who you are! -The `mkiocccentry(1)` tool creates v7 format tarballs to prevent this. You can -do so like: +**IMPORTANT REMINDER**: make **SURE** your tarball does **NOT** reveal who you are! +The `mkiocccentry(1)` tool creates a v7 format tarball to prevent this. You can +do the same like:

```