Break up text about required files in guidelines

This should (hopefully) make it easier to read.
This commit is contained in:
Cody Boone Ferguson committed 2025-01-30 12:10:38 -08:00
1 parent db6fd9ab66
commit 68b9b5983c
2 files changed
+51 -24

No files matched your search

+24 -12
View File
@@ -823,20 +823,32 @@ are considered more portable.
The maximum total number of files that may be submitted has changed to 39 files. The maximum total number of files that may be submitted has changed to 39 files.
However, of those files, 5 are mandatory (<code>prog.c</code>, <code>Makefile</code>, <code>remarks.md</code> and However, of those files, 5 are mandatory (<code>prog.c</code>, <code>Makefile</code>, <code>remarks.md</code> and
the two JSON files generated by <code>mkiocccentry(1)</code>, <code>.info.json</code> and the two JSON files generated by <code>mkiocccentry(1)</code>, <code>.info.json</code> and
<code>.auth.json</code>). Additionally, three of the files in the limit <strong>MUST</strong> be <code>.auth.json</code>).
specific file(name)s: the <strong>OPTIONAL</strong> submission files, which are <code>prog.alt.c</code>, </p>
<code>try.sh</code> and <code>try.alt.sh</code>, or else they <strong>WILL</strong> count as an extra file. Of <p class="leftbar">
course, if you use the optional filenames without the files being their Additionally, three of the files, if included, <strong>MUST</strong> be
intended, that would be an abuse of rules. specific file(name)s and in the top level directory, or they will be counted as
For more details on the optional files, see the an extra file, not an optional file.
FAQ on the “<a href="../faq.html#try_script">try.sh script system</a>” </p>
and the <p class="leftbar">
FAQ on “<a href="../faq.html#alt_code">alt code</a>”. In particular, any file that is not <code>prog.c</code>, <code>Makefile</code>, <code>remarks.md</code>,
<code>try.sh</code>, <code>prog.alt.c</code> or <code>try.alt.sh</code> will be counted as an extra file, and if
<code>try.sh</code>, <code>prog.alt.c</code> or <code>try.alt.sh</code> are not in the top level directory they
will also be counted as an extra file. The <code>.info.json</code> and <code>.auth.json</code> files
are not counted as extra files but are required.
</p> </p>
<p class="leftbar"> <p class="leftbar">
In other words, the actual amount of <strong>EXTRA</strong> files is 31. In other words, the actual amount of <strong>EXTRA</strong> files is 31.
</p> </p>
<p class="leftbar"> <p class="leftbar">
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 “<a href="../faq.html#try_script">try.sh script system</a>”
and the
FAQ on “<a href="../faq.html#alt_code">alt code</a>”.
</p>
<p class="leftbar">
If you do need to include more files, you may do so by including as an extra If you do need to include more files, you may do so by including as an extra
file, a tarball. This does <strong>NOT</strong> have to pass <code>txzchk(1)</code> tests; only the file, a tarball. This does <strong>NOT</strong> have to pass <code>txzchk(1)</code> tests; only the
submission tarball must pass the <code>txzchk(1)</code> tests. See the <a href="#txzchk">txzchk submission tarball must pass the <code>txzchk(1)</code> tests. See the <a href="#txzchk">txzchk
@@ -847,9 +859,9 @@ If you <strong>DO</strong> include a tarball, and the build process or the progr
said tarball(s), the make <code>clobber</code> rule <strong>MUST</strong> remove them. said tarball(s), the make <code>clobber</code> rule <strong>MUST</strong> remove them.
</p> </p>
<p class="leftbar"> <p class="leftbar">
<strong>IMPORTANT REMINDER</strong>: make <strong>SURE</strong> your tarball DOES <strong>NOT</strong> reveal who you are! <strong>IMPORTANT REMINDER</strong>: make <strong>SURE</strong> your tarball does <strong>NOT</strong> reveal who you are!
The <code>mkiocccentry(1)</code> tool creates v7 format tarballs to prevent this. You can The <code>mkiocccentry(1)</code> tool creates a v7 format tarball to prevent this. You can
do so like: do the same like:
</p> </p>
<pre><code> tar --format=v7 -cJf foo.txz directory</code></pre> <pre><code> tar --format=v7 -cJf foo.txz directory</code></pre>
<p class="leftbar"> <p class="leftbar">
+27 -12
View File
@@ -493,21 +493,36 @@ Jump to: [top](#)
The maximum total number of files that may be submitted has changed to 39 files. 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 However, of those files, 5 are mandatory (`prog.c`, `Makefile`, `remarks.md` and
the two JSON files generated by `mkiocccentry(1)`, `.info.json` and the two JSON files generated by `mkiocccentry(1)`, `.info.json` and
`.auth.json`). Additionally, three of the files in the limit **MUST** be `.auth.json`).
specific file(name)s: the **OPTIONAL** submission files, which are `prog.alt.c`, </p>
`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 <p class="leftbar">
intended, that would be an abuse of rules. Additionally, three of the files, if included, **MUST** be
For more details on the optional files, see the specific file(name)s and in the top level directory, or they will be counted as
FAQ on the "[try.sh script system](../faq.html#try_script)" an extra file, not an optional file.
and the </p>
FAQ on "[alt code](../faq.html#alt_code)".
<p class="leftbar">
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.
</p> </p>
<p class="leftbar"> <p class="leftbar">
In other words, the actual amount of **EXTRA** files is 31. In other words, the actual amount of **EXTRA** files is 31.
</p> </p>
<p class="leftbar">
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)".
</p>
<p class="leftbar"> <p class="leftbar">
If you do need to include more files, you may do so by including as an extra 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 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.
</p> </p>
<p class="leftbar"> <p class="leftbar">
**IMPORTANT REMINDER**: make **SURE** your tarball DOES **NOT** reveal who you are! **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 The `mkiocccentry(1)` tool creates a v7 format tarball to prevent this. You can
do so like: do the same like:
</p> </p>
``` <!---sh--> ``` <!---sh-->