checkpoint rules version 29.04 2025-11-20
Switched to "#" (hash) for headings in `rules.md`. Added "-" (dash) after the rule number and before the rule keyword. Adjusted links rules elsewhere according to the above. Ran `make quick_www` to perform the above.
This commit is contained in:
1 parent
5021fa611b
commit
ee2f499839
15 files changed
+305
-326
No files matched your search
@@ -480,7 +480,7 @@
|
||||
<li><strong>Q 1.4</strong>: <a class="normal" href="#mkiocccentry_test">How can I check if my submission passes tests without having to answer questions?</a></li>
|
||||
<li><strong>Q 1.5</strong>: <a class="normal" href="#extra-files">What are extra files and how may I include additional files beyond the max allowed?</a></li>
|
||||
<li><strong>Q 1.6</strong>: <a class="normal" href="#ai">May I use AI, LLM, Virtual coding assistants, or similar tools to write my submission?</a></li>
|
||||
<li><strong>Q 1.7</strong>: <a class="normal" href="#rule17">What are the details behind Rule 17?</a></li>
|
||||
<li><strong>Q 1.7</strong>: <a class="normal" href="#rule17">What are the details behind Rule 17 - Packaging?</a></li>
|
||||
<li><strong>Q 1.8</strong>: <a class="normal" href="#uuid">How can I avoid re-entering my UUID to mkiocccentry?</a></li>
|
||||
<li><strong>Q 1.9</strong>: <a class="normal" href="#submission_dir">How can I avoid having to move or delete my submission directory for the same workdir?</a></li>
|
||||
<li><strong>Q 1.10</strong>: <a class="normal" href="#download_submission">Can I download my submission tarball from the submit server?</a></li>
|
||||
@@ -492,7 +492,7 @@
|
||||
<li><strong>Q 2.1</strong>: <a class="normal" href="#feedback">How can I comment or make a suggestion on IOCCC rules, guidelines and tools?</a></li>
|
||||
<li><strong>Q 2.2</strong>: <a class="normal" href="#warnings">Are there any compiler warnings that I should not worry about in my submissions?</a></li>
|
||||
<li><strong>Q 2.3</strong>: <a class="normal" href="#frequent-themes">What types of entries have been frequently submitted to the IOCCC?</a></li>
|
||||
<li><strong>Q 2.4</strong>: <a class="normal" href="#rule_2_broken">How did an entry that breaks the size rule 2 win the IOCCC?</a></li>
|
||||
<li><strong>Q 2.4</strong>: <a class="normal" href="#rule_2_broken">How did an entry win the IOCCC that breaks Rule 2 - Size?</a></li>
|
||||
<li><strong>Q 2.5</strong>: <a class="normal" href="#submissions">How many submissions do the judges receive for a given IOCCC?</a></li>
|
||||
<li><strong>Q 2.6</strong>: <a class="normal" href="#judging_time">How much time does it take to judge the contest?</a></li>
|
||||
<li><strong>Q 2.7</strong>: <a class="normal" href="#judging_rounds">How many judging rounds do you have?</a></li>
|
||||
@@ -658,7 +658,7 @@
|
||||
repo</a> and it is <strong>required</strong> that you
|
||||
use it to package your submission. Not doing so puts you at a great risk of
|
||||
violating the <a href="next/rules.html">Rules</a> and in particular
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p>
|
||||
<p>Jump to: <a href="#">top</a></p>
|
||||
<div id="about_mkiocccentry">
|
||||
<h4 id="q-0.1.1-what-is-mkiocccentry-in-simple-terms">Q 0.1.1: What is <code>mkiocccentry</code> in simple terms?</h4>
|
||||
@@ -773,7 +773,7 @@ directory</strong> will be created, with the name based on your IOCCC registrati
|
||||
username, which is <strong>in the form of a UUID</strong>, and submission number along with
|
||||
the timestamp; see the <a href="next/rules.html">rules</a> for more details on this, and in
|
||||
particular
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p>
|
||||
<p><strong>IMPORTANT NOTE</strong>: the tools that require other tools, <code>mkiocccentry(1)</code> and
|
||||
<code>txzchk(1)</code>, will, as of version <code>2.0.2 2025-03-11</code>, search under <code>$PATH</code>. If
|
||||
you have an earlier version and you have not installed the tools and run the
|
||||
@@ -934,7 +934,7 @@ rounds; we look at the author name only if an entry wins. See the
|
||||
<li>leaving the remark section empty (which would also indicate that you did not
|
||||
use <code>mkiocccentry(1)</code>, as it requires it to not be of size 0, though if you only
|
||||
include whitespace you would still be violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>).</li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>).</li>
|
||||
</ul>
|
||||
<p>Jump to: <a href="#">top</a></p>
|
||||
<div id="try_scripts">
|
||||
@@ -978,11 +978,11 @@ for more details.</p>
|
||||
<p>See the
|
||||
FAQ on “<a href="#rule17">Rule 17</a>”
|
||||
and
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>
|
||||
itself.</p>
|
||||
<p>Do remember that if your submission requires different filenames, then you
|
||||
<strong>MUST</strong> make a <strong>COPY</strong> of them in your <code>Makefile</code>. See also
|
||||
<a href="next/rules.html#rule-5-purity">Rule 5 Purity</a>.</p>
|
||||
<a href="next/rules.html#rule-5---purity">Rule 5 - Purity</a>.</p>
|
||||
<p>Jump to: <a href="#">top</a></p>
|
||||
<hr style="width:50%;text-align:left;margin-left:0">
|
||||
<hr style="width:50%;text-align:left;margin-left:0">
|
||||
@@ -1126,12 +1126,12 @@ level directory.</p>
|
||||
itself is an extra file, meaning it counts <strong>AS</strong> an extra file.
|
||||
This file does <strong>NOT</strong> need to pass the <code>txzchk(1)</code> tests; only your submission
|
||||
tarball needs to pass these tests. However see below if you do do this.</p>
|
||||
<p>Please pay careful attention to <a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a> and in
|
||||
<p>Please pay careful attention to <a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a> and in
|
||||
particular the part about the maximum number of files per
|
||||
submission, which not only discusses the maximum
|
||||
number of files but also specific rules you must follow
|
||||
if you do include a tarball. Not following these points puts you at great risk
|
||||
of violating <a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p>
|
||||
of violating <a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p>
|
||||
<p>Also, remember what the <a href="next/guidelines.html">guidelines</a> say:</p>
|
||||
<blockquote>
|
||||
<p><strong>IMPORTANT REMINDER</strong>: make <strong>SURE</strong> your tarball does <strong>NOT</strong> reveal who you are!
|
||||
@@ -1155,7 +1155,7 @@ ultimate author of the code you submit.</p>
|
||||
you used as well as how you used them to help write your submission.</p>
|
||||
<p>Jump to: <a href="#">top</a></p>
|
||||
<div id="rule17">
|
||||
<h3 id="q-1.7-what-are-details-behind-rule-17">Q 1.7: What are details behind Rule 17?</h3>
|
||||
<h3 id="q-1.7-what-are-details-behind-rule-17---packaging">Q 1.7: What are details behind Rule 17 - Packaging?</h3>
|
||||
</div>
|
||||
<h3 id="tldr-rule-17---use-mkiocccentry1">TL;DR Rule 17 - Use <code>mkiocccentry(1)</code></h3>
|
||||
<p>This is a <strong>COMPLEX</strong> rule. <strong>Violating this rule WILL CAUSE YOUR SUBMISSION TO
|
||||
@@ -1174,7 +1174,7 @@ contains <strong>IMPORTANT</strong> tools and libraries such as:</p>
|
||||
<li><code>chksubmit(1)</code> (which uses <code>jparse(3)</code> and is a wrapper to <code>chkentry(1)</code>)</li>
|
||||
</ul>
|
||||
<p>The above mentioned tools will help you verify that your submission
|
||||
conforms to <a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>. Each of these tool has a <code>-h</code>
|
||||
conforms to <a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>. Each of these tool has a <code>-h</code>
|
||||
option that provides command line help. For additional details of each tool, see
|
||||
its man page, and in some cases, the <a href="next/guidelines.html">IOCCC guidelines</a>.</p>
|
||||
<p>The maximum number of <strong>extra files</strong> is 31. See the
|
||||
@@ -1224,7 +1224,7 @@ for help.</p>
|
||||
<p>The <code>remarks.md</code> <strong>MUST</strong> be a <strong>non</strong>-empty file in markdown format
|
||||
(<code>mkiocccentry(1)</code> only checks the file size but if you do not have any text in
|
||||
it you still risk violating this rule). See also
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>
|
||||
and our
|
||||
FAQ on “<a href="#remarks_md">remarks.md</a>”,
|
||||
our
|
||||
@@ -1318,16 +1318,16 @@ permissions and <code>mkiocccentry(1)</code> does this for you. In particular: d
|
||||
<code>-r-xr-xr-x</code> (i.e. <code>0555</code>); and all other files <strong>MUST</strong> be <code>-r--r--r--</code> (i.e.
|
||||
<code>0444</code>). If any file or directory does not have the correct permissions, your
|
||||
submission <strong>WILL</strong> be rejected for violating
|
||||
<a href="next/rules.html#rule17">Rule 17 Packaging</a>!</p>
|
||||
<a href="next/rules.html#rule17">Rule 17 - Packaging</a>!</p>
|
||||
<p>After <code>mkiocccentry(1)</code> creates the directories and copies the files with these
|
||||
modes, it also verifies them after the fact and if they are not correct it is an
|
||||
<strong>error</strong>.</p>
|
||||
<p>If you do need different permissions, then see the
|
||||
FAQ on “<a href="#file_perms">file permissions</a>”. Also keep in mind
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>,
|
||||
<a href="next/rules.html#rule-5-purity">Rule 5 Purity</a>,
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>,
|
||||
<a href="next/rules.html#rule-5---purity">Rule 5 - Purity</a>,
|
||||
and
|
||||
<a href="next/rules.html#rule-16-anonymous">Rule 16 Anonymous</a>.</p>
|
||||
<a href="next/rules.html#rule-16---anonymous">Rule 16 - Anonymous</a>.</p>
|
||||
<p>The <code>txzchk(1)</code> tool will also verify file/directory permissions (and many other
|
||||
things) for you, and so will <code>chksubmit(1)</code> (along with other checks on files and
|
||||
directories in your submission directory, including the two required JSON files,
|
||||
@@ -1340,18 +1340,18 @@ page</a>.</p>
|
||||
will run <code>fnamchk(1)</code> as part of its algorithm. If you use <code>mkiocccentry(1)</code>
|
||||
there should be no problem but if you were to package things manually it is
|
||||
possible there could be a problem and this poses a big risk of violating
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>
|
||||
or
|
||||
<a href="next/rules.html#rule17">Rule 17 Packaging</a>.</p>
|
||||
<a href="next/rules.html#rule17">Rule 17 - Packaging</a>.</p>
|
||||
<p>The <code>fnamchk(1)</code>, which <code>txzchk(1)</code> executes, will verify that the
|
||||
filename is correct. But if you do package your tarball manually, and you have a
|
||||
mismatch in what is in the tarball and the name, <code>txzchk(1)</code> will flag the
|
||||
discrepancy as an error and exit with non-zero.</p>
|
||||
<p>These checks <strong>MUST PASS</strong>. If they do not you stand a significant chance of
|
||||
having your submission rejected for violating
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>
|
||||
or
|
||||
<a href="next/rules.html#rule17">Rule 17 Packaging</a>.</p>
|
||||
<a href="next/rules.html#rule17">Rule 17 - Packaging</a>.</p>
|
||||
<div id="max-files">
|
||||
<h4 id="maximum-number-of-files-per-submission">Maximum number of files per submission</h4>
|
||||
</div>
|
||||
@@ -1381,9 +1381,9 @@ The <code>mkiocccentry(1)</code> tool uses the v7 format. For instance you might
|
||||
<pre><code> tar --format=v7 -cJf foo.txz directory</code></pre>
|
||||
<hr style="width:50%;text-align:left;margin-left:0">
|
||||
<p><strong>IMPORTANT</strong>: where
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>,
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>,
|
||||
and
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.
|
||||
and the tools from the latest
|
||||
release of the <a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry repo</a>
|
||||
conflict, the <a href="judges.html">IOCCC judges</a> will use their best judgment which
|
||||
@@ -1418,9 +1418,9 @@ page</a>,
|
||||
for help here and also read our
|
||||
FAQ on “<a href="#mkiocccentry_bugs">mkiocccentry repo bugs</a>”.</p>
|
||||
<p>At the risk of stating the obvious: submissions that violate
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>,
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>,
|
||||
or
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>
|
||||
<strong>WILL BE REJECTED</strong>, so <strong>BE SURE</strong> to use the latest release of the
|
||||
<a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry repo</a>, to form and test
|
||||
your submission’s xz compressed tarball. Do <strong>NOT</strong> assume you have the most
|
||||
@@ -1683,7 +1683,7 @@ of the same theme.</p>
|
||||
<p>Jump to: <a href="#">top</a></p>
|
||||
<div id="rule_2_broken">
|
||||
<div id="rule_breaking_entry">
|
||||
<h3 id="q-2.4-how-did-an-entry-that-breaks-the-size-rule-2-win-the-ioccc">Q 2.4: How did an entry that breaks the size rule 2 win the IOCCC?</h3>
|
||||
<h3 id="q-2.4-how-did-an-entry-win-the-ioccc-that-breaks-rule-2---size">Q 2.4: How did an entry win the IOCCC that breaks Rule 2 - Size?</h3>
|
||||
</div>
|
||||
</div>
|
||||
<p>As entries have been fixed it is entirely possible that some of the entries no
|
||||
@@ -1900,9 +1900,9 @@ two JSON files, <code>.auth.json</code> and <code>.info.json</code> as well as t
|
||||
<code>.info.json</code> manifest. (Okay there is an option to skip files but this is for
|
||||
the judges <strong>ONLY</strong>; use of this option to validate your submission puts you at
|
||||
a great risk of violating
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>,
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>,
|
||||
or
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!).</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!).</p>
|
||||
<p>As an example, if your submission directory is
|
||||
<code>00000000-0000-4000-0000-000000000000-3/</code> then you should run the following
|
||||
command:</p>
|
||||
@@ -1922,9 +1922,9 @@ FAQ on “<a href="#auth_json">.auth.json</a>”
|
||||
and the
|
||||
FAQ on “<a href="#info_json">.info.json</a>”
|
||||
as well as
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>,
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>,
|
||||
and
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>
|
||||
for more information.</p>
|
||||
<p><strong>NOTE</strong>: the <code>chksubmit(1)</code> tool invokes <code>chkentry(1)</code> but as a contestant you
|
||||
do not need to worry about those details. One should use <code>chksubmit(1)</code> instead
|
||||
@@ -2015,12 +2015,12 @@ to be valid. If this is not the case your submission <strong>WILL BE</strong> re
|
||||
<li>The IOCCC contestant ID used as a username in the form of <strong>in the form of
|
||||
a UUID</strong> and submission number; see the <a href="next/rules.html">Rules</a> for more details
|
||||
on this, and in particular
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</li>
|
||||
</ul>
|
||||
<p><strong>NOTE:</strong> if the contest ID is <strong>NOT</strong> in this format then <code>fnamchk</code> will
|
||||
report it as an <strong>error</strong> and your submission <strong>WILL BE</strong> rejected for
|
||||
violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p></li>
|
||||
<li><p><code>tarball</code> (double quoted string)</p>
|
||||
<ul>
|
||||
<li>The xz compressed tarball filename.</li>
|
||||
@@ -2028,10 +2028,10 @@ violating
|
||||
<p><strong>IMPORTANT:</strong> this <strong>MUST</strong> match the actual tarball’s <strong>filename</strong> in order for
|
||||
this to be valid. If there is a mismatch you stand a great risk of having
|
||||
your submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!
|
||||
Moreover, it is possible that <code>txzchk</code> will report a problem through
|
||||
<code>fnamchk(1)</code> which also puts you at great risk of violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>. The
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>. The
|
||||
<code>txzchk(1)</code> tool will use the output of <code>fnamchk</code> to
|
||||
obtain the correct directory <em>name</em> in the tarball; if <code>fnamchk</code> fails to
|
||||
validate your filename, or if you have the wrong directory name in the
|
||||
@@ -2046,7 +2046,7 @@ tarball, this will be flaggd.</p></li>
|
||||
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>). If
|
||||
this is not the case you stand a great risk of having your submission
|
||||
rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p></li>
|
||||
<li><p><code>author_count</code> (number)</p>
|
||||
<ul>
|
||||
<li>How many authors this submission has.</li>
|
||||
@@ -2119,7 +2119,7 @@ the range of 1 <strong>THROUGH</strong> <code>MAX_AFFILIATION_LEN</code> (see
|
||||
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>). If
|
||||
this is not the case you stand a great risk of having your submission
|
||||
rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p>
|
||||
<p><strong>NOTE:</strong> an <strong>affiliation</strong> does <strong>NOT</strong> have any affect on whether you will win or not.</p></li>
|
||||
<li><p><code>past_winning_author</code> (boolean)</p>
|
||||
<ul>
|
||||
@@ -2204,9 +2204,9 @@ will use it on the submission directory as part of the judging process.</p>
|
||||
is reported invalid by <code>chksubmit(1)</code>, or if your submission directory is
|
||||
reported invalid by <code>chksubmit(1)</code>, your submission will almost certainly be
|
||||
rejected for violating the <a href="next/rules.html">Rules</a> and in particular
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>,
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>,
|
||||
and
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p>
|
||||
<p>An obvious example where <code>chksubmit(1)</code> would fail to validate <code>.auth.json</code> is if
|
||||
there is a mismatch of type in the JSON file with what is expected, for
|
||||
instance, if in <code>.auth.json</code> the <code>no_comment</code> that we chose to not comment on is
|
||||
@@ -2215,9 +2215,9 @@ out of range (see above for list). Two more examples would be if a field is
|
||||
missing or if an unknown filed is in the file. In these cases (and any others
|
||||
that must be established as valid by <code>chksubmit(1)</code>) your submission would be
|
||||
rejected for violating
|
||||
<a href="next/rules.html#rule-4-files">Rule 4 Files</a>,
|
||||
<a href="next/rules.html#rule-4---files">Rule 4 - Files</a>,
|
||||
and
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>
|
||||
and in particular
|
||||
because <code>chksubmit(1)</code> would not validate the <code>.auth.json</code> file (and maybe other
|
||||
things too).</p>
|
||||
@@ -2337,7 +2337,7 @@ this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
|
||||
<li>The IOCCC contestant ID used as a username in the form of <strong>in the form of
|
||||
a UUID</strong> and submission number; see the <a href="next/rules.html">rules</a> for more details
|
||||
on this, and in particular
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</li>
|
||||
</ul></li>
|
||||
<li><p><code>submit_slot</code> (number)</p>
|
||||
<ul>
|
||||
@@ -2349,7 +2349,7 @@ on this, and in particular
|
||||
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>). If
|
||||
this is not the case you stand a great risk of having your submission
|
||||
rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p></li>
|
||||
<li><p><code>title</code> (double quoted string)</p>
|
||||
<ul>
|
||||
<li>A short name (length >= 1 <strong>THROUGH</strong> <code>MAX_TITLE_LEN</code>, defined in
|
||||
@@ -2359,7 +2359,7 @@ matches the regexp <code>[a-z0-9][a-z0-9_+-]*</code>.</li>
|
||||
</ul>
|
||||
<p><strong>IMPORTANT:</strong> if this is <strong>NOT</strong> the case you stand a great risk of having your submission
|
||||
rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p></li>
|
||||
<li><p><code>abstract</code> (double quoted string)</p>
|
||||
<ul>
|
||||
<li>A one line summary of your submission, with a length of 1 <strong>THROUGH</strong>
|
||||
@@ -2370,7 +2370,7 @@ in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a
|
||||
<p>The <code>abstract</code> may not contain a <code>;</code> (semicolon), nor <code>&</code> (ampersand), nor <code>,</code> (comma).</p>
|
||||
<p><strong>IMPORTANT:</strong> if your abstract is 0 in length or > the maximum abstract length you
|
||||
stand a great risk of having your submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p></li>
|
||||
<li><p><code>tarball</code> (double quoted string)</p>
|
||||
<ul>
|
||||
<li>The xz compressed tarball filename.</li>
|
||||
@@ -2378,10 +2378,10 @@ stand a great risk of having your submission rejected for violating
|
||||
<p><strong>IMPORTANT:</strong> this <strong>MUST</strong> match the actual tarball’s <strong>filename</strong> in order for
|
||||
this to be valid. If there is a mismatch you stand a great risk of having
|
||||
your submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!
|
||||
Moreover, it is possible that <code>txzchk</code> will report a problem through
|
||||
<code>fnamchk(1)</code> which also puts you at great risk of violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.
|
||||
The <code>txzchk(1)</code> tool will use the output of <code>fnamchk</code> to
|
||||
obtain the correct directory <em>name</em> in the tarball; if <code>fnamchk</code> fails to
|
||||
validate your filename, or if you have the wrong directory name in the
|
||||
@@ -2417,7 +2417,7 @@ violation, else <code>false</code>.</li>
|
||||
calculated size is <strong>NOT</strong>
|
||||
violated but this is <code>true</code> then you stand a good chance of having your
|
||||
submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p></li>
|
||||
<li><p><code>rule_2a_mismatch</code> (boolean)</p>
|
||||
<ul>
|
||||
<li><code>true</code> if
|
||||
@@ -2436,12 +2436,12 @@ violation, else <code>false</code>.</li>
|
||||
calculated size is <strong>NOT</strong>
|
||||
violated but this is <code>true</code> then you stand a good chance of having your
|
||||
submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>.</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>.</p></li>
|
||||
<li><p><code>highbit_warning</code> (boolean)</p>
|
||||
<ul>
|
||||
<li><code>true</code> if <code>iocccsize</code> detects a high bit (unescaped octets with the high
|
||||
bit set - octet value >= 128); see
|
||||
<a href="next/rules.html#rule-12-utf-8">Rule 12 UTF-8</a>,
|
||||
<a href="next/rules.html#rule-12---utf-8">Rule 12 - UTF-8</a>,
|
||||
else <code>false</code>.</li>
|
||||
</ul></li>
|
||||
<li><p><code>nul_warning</code> (boolean)</p>
|
||||
@@ -2469,7 +2469,7 @@ else <code>false</code>.</li>
|
||||
</ul>
|
||||
<p><strong>IMPORTANT:</strong> if the <code>Makefile</code> file has no problems and this is <code>true</code> then
|
||||
you stand a good chance of having your submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p>
|
||||
<p>See the
|
||||
FAQ on “<a href="#makefile">Makefile</a>”
|
||||
for more information.</p></li>
|
||||
@@ -2479,7 +2479,7 @@ for more information.</p></li>
|
||||
</ul>
|
||||
<p><strong>IMPORTANT:</strong>: if the <code>Makefile</code> file does <strong>NOT</strong> have an <code>all</code> rule then
|
||||
you stand a good chance of having your submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p>
|
||||
<p>See the
|
||||
FAQ on “<a href="#makefile">Makefile</a>”
|
||||
for more information.</p></li>
|
||||
@@ -2490,7 +2490,7 @@ for more information.</p></li>
|
||||
<p><strong>IMPORTANT:</strong> if the <code>Makefile</code> file does <strong>NOT</strong> have an <code>all</code> rule and this
|
||||
boolean is <code>true</code> then you stand a good chance of having your
|
||||
submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p>
|
||||
<p>See the
|
||||
FAQ on “<a href="#makefile">Makefile</a>”
|
||||
for more information.</p></li>
|
||||
@@ -2501,7 +2501,7 @@ for more information.</p></li>
|
||||
<p><strong>IMPORTANT:</strong> if the <code>Makefile</code> file does <strong>NOT</strong> have a <code>clean</code> rule and this
|
||||
boolean is <code>true</code> then you stand a good chance of having your submission
|
||||
rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p>
|
||||
<p>See the
|
||||
FAQ on “<a href="#makefile">Makefile</a>”
|
||||
for more information.</p></li>
|
||||
@@ -2512,7 +2512,7 @@ for more information.</p></li>
|
||||
<p><strong>IMPORTANT:</strong> if the <code>Makefile</code> file does <strong>NOT</strong> have an <code>clobber</code> rule and this
|
||||
boolean is <code>true</code> then you stand a good chance of having your submission
|
||||
rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p>
|
||||
<p>See the
|
||||
FAQ on “<a href="#makefile">Makefile</a>”
|
||||
for more information.</p></li>
|
||||
@@ -2523,7 +2523,7 @@ for more information.</p></li>
|
||||
<p><strong>IMPORTANT:</strong> if the <code>Makefile</code> file does <strong>NOT</strong> have a <code>try</code> rule and this
|
||||
boolean is <code>true</code> then you stand a good chance of having your submission
|
||||
rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p>
|
||||
<p>See the
|
||||
FAQ on “<a href="#makefile">Makefile</a>”
|
||||
for more information.</p></li>
|
||||
@@ -2549,7 +2549,7 @@ for more information.</li>
|
||||
</ul>
|
||||
<p><strong>IMPORTANT:</strong> if this is <strong>NOT</strong> the case you stand a
|
||||
great chance of having your submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p></li>
|
||||
<li><p><code>auth_JSON</code> (double quoted string)</p>
|
||||
<ul>
|
||||
<li>This <code>MUST</code> be <code>".auth.json"</code>, defined as <code>AUTH_JSON_FILENAME</code> in
|
||||
@@ -2562,7 +2562,7 @@ for more information.</li>
|
||||
</ul>
|
||||
<p><strong>IMPORTANT:</strong> if this is <strong>NOT</strong> the case you stand a great chance of having your
|
||||
submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p></li>
|
||||
<li><p><code>c_src</code> (double quoted string)</p>
|
||||
<ul>
|
||||
<li>This <code>MUST</code> be <code>"prog.c"</code>, defined as <code>PROG_C_FILENAME</code> in
|
||||
@@ -2572,7 +2572,7 @@ is your submission source code.</li>
|
||||
</ul>
|
||||
<p><strong>IMPORTANT:</strong> if this is <strong>NOT</strong> the case you stand a great chance of having your
|
||||
submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p></li>
|
||||
<li><p><code>Makefile</code> (double quoted string)</p>
|
||||
<ul>
|
||||
<li>This <code>MUST</code> be <code>"Makefile"</code>, defined as <code>MAKEFILE_FILENAME</code> in
|
||||
@@ -2585,7 +2585,7 @@ for more information.</li>
|
||||
</ul>
|
||||
<p><strong>IMPORTANT:</strong> if this is <strong>NOT</strong> the case you stand a great chance of having your
|
||||
submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p></li>
|
||||
<li><p><code>remarks</code> (double quoted string)</p>
|
||||
<ul>
|
||||
<li>This <code>MUST</code> be <code>"remarks.md"</code>, defined as <code>REMARKS_FILENAME</code> in
|
||||
@@ -2598,7 +2598,7 @@ for more information.</li>
|
||||
</ul>
|
||||
<p><strong>IMPORTANT:</strong> if this is <strong>NOT</strong> the case you stand a great chance of having your
|
||||
submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!</p></li>
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!</p></li>
|
||||
</ul>
|
||||
<p>The <code>manifest</code> <strong>array</strong> also <strong>OPTIONALLY</strong> has one or more of the field:</p>
|
||||
<ul>
|
||||
@@ -2611,7 +2611,7 @@ and <code>chksubmit</code> will verify this for you; it is <strong>ALSO</strong>
|
||||
filenames are not unique, not POSIX plus + safe chars only, if they are the
|
||||
wrong permission and various other things. In these cases you stand a great
|
||||
risk of having your submission rejected for violating
|
||||
<a href="next/rules.html#rule-17-packaging">Rule 17 Packaging</a>!
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>!
|
||||
On the other hand, <strong>ONLY</strong> <code>mkiocccentry</code> will
|
||||
verify that the files exist and can be read; <code>txzchk(1)</code> will <strong>NOT</strong> do
|
||||
this for you as it only <strong>LISTS</strong> the tarball: it does <strong>NOT</strong> extract it.
|
||||
@@ -2674,7 +2674,7 @@ out of range (see above for list). Two more examples would be if a field is
|
||||
missing or if an unknown filed is in the file. In these cases (and any others
|
||||
that must be established as valid by <code>chksubmit</code>) your submission would be
|
||||
rejected for violating
|
||||
Rule 17 Packaging](next/rules.html#rule-17-packaging),
|
||||
<a href="next/rules.html#rule-17---packaging">Rule 17 - Packaging</a>,
|
||||
and in particular
|
||||
because <code>chksubmit</code> would not validate the <code>.info.json</code> file.</p>
|
||||
<p>If you wish to <strong>verify</strong> that your <code>.info.json</code> file is valid <strong>JSON</strong> then see the
|
||||
|
||||
Reference in new issue
Block a user