mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix faq.md HTML flaw, improve string and no_comment

Browse Source
This commit is contained in:
Landon Curt Noll committed 2024-07-14 13:15:21 -07:00
1 parent d6f2bffd0e
commit 386ece032b
2 files changed
+120 -84
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

faq.html
+62 -41
View File
@@ -835,11 +835,11 @@ information about the author or authors of the submission, in JSON format. The
JSON <code>authors</code> <strong>array</strong> holds the following information about the authors of the
submission:</p>
<ul>
<li><p><code>name</code> (string)</p>
<li><p><code>name</code> (double quoted string)</p>
<ul>
<li>The <strong>name</strong> of this author.</li>
</ul></li>
<li><p><code>location_code</code> (string)</p>
<li><p><code>location_code</code> (double quoted string)</p>
<ul>
<li>The <strong>location code</strong> of this author (an ISO 3166-1 2 character code).
See
@@ -847,29 +847,29 @@ See
for a list of valid codes.</li>
</ul>
<p><strong>NOTE:</strong> in <code>mkiocccentry</code> use <code>XX</code> if you want your location to be anonymous.</p></li>
<li><p><code>email</code> (string)</p>
<li><p><code>email</code> (null or double quoted string)</p>
<ul>
<li>The <strong>email</strong> of this author in the form of <code>x@y</code>, or <code>null</code> if not provided.</li>
</ul></li>
<li><p><code>url</code> (string)</p>
<li><p><code>url</code> (null or double quoted string)</p>
<ul>
<li>The primary <strong>URL</strong> of this author, or <code>null</code> if not provided.</li>
</ul></li>
<li><p><code>alt_url</code> (string)</p>
<li><p><code>alt_url</code> (null or double quoted string)</p>
<ul>
<li>The <strong>alt URL</strong> of this author, or <code>null</code> if not provided.</li>
</ul></li>
<li><p><code>mastodon</code> (string)</p>
<li><p><code>mastodon</code> (null or double quoted string)</p>
<ul>
<li>The <strong><a href="#try_mastodon">Mastodon</a> handle</strong> of this author in the form of <code>@user@domain</code>, or
<code>null</code> if not provided.</li>
</ul></li>
<li><p><code>github</code> (string)</p>
<li><p><code>github</code> (null or double quoted string)</p>
<ul>
<li>The <strong><a href="https://github.com">GitHub</a> account</strong> of this author in the form of <code>@user</code>, or <code>null</code> if not
provided.</li>
</ul></li>
<li><p><code>affiliation</code> (string)</p>
<li><p><code>affiliation</code> (null or double quoted string)</p>
<ul>
<li>This author’s <strong>affiliation</strong>, if any, or <code>null</code> if not provided.</li>
</ul>
@@ -891,7 +891,7 @@ author has <strong>NOT</strong> won before.</li>
<li><code>true</code> if this default handle was accepted, <code>false</code> if one is provided
by this author.</li>
</ul></li>
<li><p><code>author_handle</code> (string)</p>
<li><p><code>author_handle</code> (double quoted string)</p>
<ul>
<li>This author’s handle (custom or default provided).</li>
</ul>
@@ -908,12 +908,22 @@ file and how are they used?</a>).</p></li>
<h3 id="additional-fields-in-.auth.json">Additional fields in <code>.auth.json</code>:</h3>
<p>The file also contains the following details:</p>
<ul>
<li><p><code>no_comment</code> (string)</p>
<li><code>no_comment</code> (double quoted string)
<ul>
<li>We can provide <code>no comment</code> about <code>no_comment</code> so we ask you to please
<strong>NOT</strong> <code>comment</code> about our <code>no comments</code>. :-)</li>
<li>We can provide <code>no comment</code> about <code>no_comment</code> other than to state that unless
<code>no_comment</code> matches the string:</li>
</ul></li>
<li><p><code>IOCCC_auth_version</code> (string)</p>
</ul>
<blockquote>
<p>mandatory comment: because comments were removed from the original JSON spec</p>
</blockquote>
<p>your submission <strong>WILL BE</strong> rejected!</p>
<p>Are we suggesting that removing comments from the JSON spec was a mistake?</p>
<blockquote>
<p>“You might very well think that; I couldn’t possibly comment” – Francis Urquhart</p>
</blockquote>
<ul>
<li><p><code>IOCCC_auth_version</code> (double quoted string)</p>
<ul>
<li>The current version of the <code>.auth.json</code> file.</li>
</ul>
@@ -922,7 +932,7 @@ file and how are they used?</a>).</p></li>
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>IOCCC_contest</code> (string)</p>
<li><p><code>IOCCC_contest</code> (double quoted string)</p>
<ul>
<li>Which contest number this is (e.g. 1 for 1984, 2 for 1985, 27 for 2020).</li>
</ul>
@@ -942,7 +952,7 @@ might not match when it ends.</p>
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h">soup/limit_ioccc.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>mkiocccentry_version</code> (string)</p>
<li><p><code>mkiocccentry_version</code> (double quoted string)</p>
<ul>
<li>The version of <code>mkiocccentry</code> that formed this <code>.auth.json</code> file.</li>
</ul>
@@ -951,7 +961,7 @@ defined as <code>MKIOCCCENTRY_VERSION</code> in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>chkentry_version</code> (string)</p>
<li><p><code>chkentry_version</code> (double quoted string)</p>
<ul>
<li>The version of <code>chkentry</code> that was used to validate this <code>.auth.json</code>,
assuming that it was created by <code>mkiocccentry</code>.</li>
@@ -961,14 +971,14 @@ as <code>CHKENTRY_VERSION</code> in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>fnamchk_version</code> (string)</p>
<li><p><code>fnamchk_version</code> (double quoted string)</p>
<ul>
<li>The version of <code>fnamchk</code> that <code>txzchk</code> uses to validate the filename of
the xz compressed tarball.</li>
</ul>
<p><strong>NOTE:</strong> this <strong>MUST</strong> match <strong>THIS</strong> IOCCC’s <code>fnamchk</code> version in order for it
to be valid. If this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>IOCCC_contest_id</code> (string)</p>
<li><p><code>IOCCC_contest_id</code> (double quoted string)</p>
<ul>
<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
@@ -977,7 +987,7 @@ on this, and in particular <a href="next/rules.html#rule17">Rule 17</a>.</li>
<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#rule17">Rule 17</a>!</p></li>
<li><p><code>tarball</code> (string)</p>
<li><p><code>tarball</code> (double quoted string)</p>
<ul>
<li>The xz compressed tarball filename.</li>
</ul>
@@ -1037,7 +1047,7 @@ formed - see <code>gettimeofday(2)</code>) second.</li>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case <code>chkentry(1)</code> will report an <strong>error</strong> and your
submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>timestamp_epoch</code> (string)</p>
<li><p><code>timestamp_epoch</code> (double quoted string)</p>
<ul>
<li><code>"Thu Jan 01 00:00:00 1970 UTC"</code> (<code>gettimeofday(2)</code> epoch).</li>
</ul>
@@ -1086,7 +1096,7 @@ JSON <code>manifest</code> array contains information about the files of the sub
<strong>including</strong> the <strong>mandatory</strong> <a href="#auth_json">.auth.json</a>, <a href="#info_json">.info.json</a>,
C source and <a href="#remarks">remarks</a> files. In particular:</p>
<ul>
<li><p><code>info_JSON</code> (string)</p>
<li><p><code>info_JSON</code> (double quoted string)</p>
<ul>
<li>This <code>MUST</code> be <code>".info.json"</code>, defined as <code>INFO_JSON_FILENAME</code> in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h">soup/entry_util.h</a>
@@ -1095,7 +1105,7 @@ it is the <a href="#info_json">.info.json</a> file that <code>mkiocccentry</code
</ul>
<p><strong>NOTE:</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#rule17">Rule 17</a>!</p></li>
<li><p><code>auth_JSON</code> (string)</p>
<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
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h">soup/entry_util.h</a>
@@ -1104,7 +1114,7 @@ it is the <a href="#auth_json">.auth.json</a> file that <code>mkiocccentry</code
</ul>
<p><strong>NOTE:</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#rule17">Rule 17</a>!</p></li>
<li><p><code>c_src</code> (string)</p>
<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
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h">soup/entry_util.h</a>
@@ -1115,7 +1125,7 @@ is your submission source code.</li>
submission rejected for violating <a href="next/rules.html#rule17">Rule 17</a>!</p>
<p><strong>NOTE:</strong> if you provide to <code>mkiocccentry</code> a different filename it will be
copied to <code>prog.c</code>.</p></li>
<li><p><code>Makefile</code> (string)</p>
<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
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h">soup/entry_util.h</a>
@@ -1126,7 +1136,7 @@ is your <a href="#makefile">Makefile</a>.</li>
submission rejected for violating <a href="next/rules.html#rule17">Rule 17</a>!</p>
<p><strong>NOTE:</strong> if you provide to <code>mkiocccentry</code> a different filename it will be
copied to <code>Makefile</code>.</p></li>
<li><p><code>remarks</code> (string)</p>
<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
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h">soup/entry_util.h</a>
@@ -1140,7 +1150,7 @@ copied to <code>remarks.md</code>.</p></li>
</ul>
<p>The <code>manifest</code> array also optionally has one or more of the field:</p>
<ul>
<li><p><code>extra_file</code> (string)</p>
<li><p><code>extra_file</code> (double quoted string)</p>
<ul>
<li>Any additional file that you need or want to include with your submission.</li>
</ul>
@@ -1157,12 +1167,22 @@ documented!</p></li>
</ul>
<p>The file also contains the following details:</p>
<ul>
<li><p><code>no_comment</code> (string)</p>
<li><code>no_comment</code> (double quoted string)
<ul>
<li>We can provide <code>no comment</code> about <code>no_comment</code> so we ask you to please
<strong>NOT</strong> <code>comment</code> about our <code>no comments</code>. :-)</li>
<li>We can provide <code>no comment</code> about <code>no_comment</code> other than to state that unless
<code>no_comment</code> matches the string:</li>
</ul></li>
<li><p><code>IOCCC_info_version</code> (string)</p>
</ul>
<blockquote>
<p>mandatory comment: because comments were removed from the original JSON spec</p>
</blockquote>
<p>your submission <strong>WILL BE</strong> rejected!</p>
<p>Are we suggesting that removing comments from the JSON spec was a mistake?</p>
<blockquote>
<p>“You might very well think that; I couldn’t possibly comment” – Francis Urquhart</p>
</blockquote>
<ul>
<li><p><code>IOCCC_info_version</code> (double quoted string)</p>
<ul>
<li>The current version of the <code>.info.json</code> files.</li>
</ul>
@@ -1171,7 +1191,7 @@ documented!</p></li>
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>IOCCC_contest</code> (string)</p>
<li><p><code>IOCCC_contest</code> (double quoted string)</p>
<ul>
<li>Which contest number this is (e.g. 1 for 1984, 2 for 1985, 27 for 2020).</li>
</ul>
@@ -1191,7 +1211,7 @@ might not match when it ends.</p>
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h">soup/limit_ioccc.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>mkiocccentry_version</code> (string)</p>
<li><p><code>mkiocccentry_version</code> (double quoted string)</p>
<ul>
<li>The version of <code>mkiocccentry</code> that formed this <code>.auth.json</code> file.</li>
</ul>
@@ -1200,7 +1220,7 @@ defined as <code>MKIOCCCENTRY_VERSION</code> in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>iocccsize_version</code> (string)</p>
<li><p><code>iocccsize_version</code> (double quoted string)</p>
<ul>
<li>The version of <code>iocccsize</code> that was used for this <code>.info.json</code> file.</li>
</ul>
@@ -1209,7 +1229,7 @@ defined as <code>IOCCCSIZE_VERSION</code> in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>chkentry_version</code> (string)</p>
<li><p><code>chkentry_version</code> (double quoted string)</p>
<ul>
<li>The version of <code>chkentry</code> that was used to validate this <code>.info.json</code>,
assuming that it was created by <code>mkiocccentry</code>.</li>
@@ -1219,7 +1239,7 @@ as <code>CHKENTRY_VERSION</code> in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>fnamchk_version</code> (string)</p>
<li><p><code>fnamchk_version</code> (double quoted string)</p>
<ul>
<li>The version of <code>fnamchk</code> that <code>txzchk</code> uses to validate the filename of
the xz compressed tarball.</li>
@@ -1229,7 +1249,7 @@ as <code>FNAMCHK_VERSION</code> in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>txzchk_version</code> (string)</p>
<li><p><code>txzchk_version</code> (double quoted string)</p>
<ul>
<li>The version of <code>txzchk</code> used to validate the xz compressed tarball.</li>
</ul>
@@ -1238,7 +1258,7 @@ as <code>TXZCHK_VERSION</code> in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/version.h">soup/version.h</a>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case your submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>IOCCC_contest_id</code> (string)</p>
<li><p><code>IOCCC_contest_id</code> (double quoted string)</p>
<ul>
<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
@@ -1257,7 +1277,7 @@ violating <a href="next/rules.html#rule17">Rule 17</a>!</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#rule17">Rule 17</a>!</p></li>
<li><p><code>title</code> (string)</p>
<li><p><code>title</code> (double quoted string)</p>
<ul>
<li>A short name (length &gt;= 1 <strong>THROUGH</strong> <code>MAX_TITLE_LEN</code>, defined in
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h">soup/limit_ioccc.h</a>
@@ -1266,7 +1286,7 @@ matches the regexp <code>[a-z0-9][a-z0-9_+-]*</code>.</li>
</ul>
<p><strong>NOTE:</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#rule17">Rule 17</a>!</p></li>
<li><p><code>abstract</code> (string)</p>
<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>
<code>MAX_ABSTRACT_LEN</code>, defined in
@@ -1276,7 +1296,7 @@ in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a
<p><strong>NOTE:</strong> if your abstract is 0 in length or &gt; the maximum abstract length you
stand a great risk of having your submission rejected for violating <a href="next/rules.html#rule17">Rule
17</a>!</p></li>
<li><p><code>tarball</code> (string)</p>
<li><p><code>tarball</code> (double quoted string)</p>
<ul>
<li>The xz compressed tarball filename.</li>
</ul>
@@ -1413,7 +1433,7 @@ formed - see <code>gettimeofday(2)</code>) second.</li>
in the <a href="https://github.com/ioccc-src/mkiocccentry/">mkiocccentry repo</a>. If
this is not the case <code>chkentry(1)</code> will report an <strong>error</strong> and your
submission <strong>WILL BE</strong> rejected!</p></li>
<li><p><code>timestamp_epoch</code> (string)</p>
<li><p><code>timestamp_epoch</code> (double quoted string)</p>
<ul>
<li><code>"Thu Jan 01 00:00:00 1970 UTC"</code> (<code>gettimeofday(2)</code> epoch).</li>
</ul>
@@ -1749,6 +1769,7 @@ to the <a href="https://www.ioccc.org">official IOCCC website</a>.</p>
<h3 id="faq-2.1-what-should-i-put-in-the-remarks.md-file-of-my-submission">FAQ 2.1: What should I put in the remarks.md file of my submission?</h3>
</div>
</div>
</div>
<p>First, <strong>PLEASE</strong> read the <a href="markdown.html">IOCCC markdown guidelines</a>.</p>
<p>Next, while you may put in as much or as little as you wish into your entry’s
<code>remarks.md</code> file, we do have few important suggestions:</p>
faq.md
+58 -43
View File
@@ -593,10 +593,10 @@ information about the author or authors of the submission, in JSON format. The
JSON `authors` **array** holds the following information about the authors of the
submission:
- `name` (string)
- `name` (double quoted string)
* The **name** of this author.
- `location_code` (string)
- `location_code` (double quoted string)
* The **location code** of this author (an ISO 3166-1 2 character code).
See
<https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements>
@@ -604,24 +604,24 @@ submission:
**NOTE:** in `mkiocccentry` use `XX` if you want your location to be anonymous.
- `email` (string)
- `email` (null or double quoted string)
* The **email** of this author in the form of `x@y`, or `null` if not provided.
- `url` (string)
- `url` (null or double quoted string)
* The primary **URL** of this author, or `null` if not provided.
- `alt_url` (string)
- `alt_url` (null or double quoted string)
* The **alt URL** of this author, or `null` if not provided.
- `mastodon` (string)
- `mastodon` (null or double quoted string)
* The **[Mastodon](#try_mastodon) handle** of this author in the form of `@user@domain`, or
`null` if not provided.
- `github` (string)
- `github` (null or double quoted string)
* The **[GitHub](https://github.com) account** of this author in the form of `@user`, or `null` if not
provided.
- `affiliation` (string)
- `affiliation` (null or double quoted string)
* This author's **affiliation**, if any, or `null` if not provided.
**NOTE:** if provided, the length of the **affiliation** **MUST** be within
@@ -643,7 +643,7 @@ submission:
* `true` if this default handle was accepted, `false` if one is provided
by this author.
- `author_handle` (string)
- `author_handle` (double quoted string)
* This author's handle (custom or default provided).
**NOTE:** if you have won before, we **ENCOURAGE** you to use the same handle of
@@ -660,11 +660,19 @@ submission:
The file also contains the following details:
- `no_comment` (string)
* We can provide `no comment` about `no_comment` so we ask you to please
**NOT** `comment` about our `no comments`. :-)
- `no_comment` (double quoted string)
* We can provide `no comment` about `no_comment` other than to state that unless
`no_comment` matches this quote:
- `IOCCC_auth_version` (string)
> "mandatory comment: because comments were removed from the original JSON spec"
your submission **WILL BE** rejected!
Are we suggesting that removing comments from the JSON spec was a mistake?
> "You might very well think that; but of course I couldn't possibly comment." -- Francis Urquhart
- `IOCCC_auth_version` (double quoted string)
* The current version of the `.auth.json` file.
**NOTE:** this **MUST** match **THIS** IOCCC's `.auth.json` version, defined as
@@ -673,7 +681,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `IOCCC_contest` (string)
- `IOCCC_contest` (double quoted string)
* Which contest number this is (e.g. 1 for 1984, 2 for 1985, 27 for 2020).
**NOTE:** this **MUST** match **THIS** IOCCC's contest value, defined as
@@ -694,7 +702,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `mkiocccentry_version` (string)
- `mkiocccentry_version` (double quoted string)
* The version of `mkiocccentry` that formed this `.auth.json` file.
**NOTE:** this **MUST** match **THIS** IOCCC's `mkiocccentry` version,
@@ -703,7 +711,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `chkentry_version` (string)
- `chkentry_version` (double quoted string)
* The version of `chkentry` that was used to validate this `.auth.json`,
assuming that it was created by `mkiocccentry`.
@@ -713,14 +721,14 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `fnamchk_version` (string)
- `fnamchk_version` (double quoted string)
* The version of `fnamchk` that `txzchk` uses to validate the filename of
the xz compressed tarball.
**NOTE:** this **MUST** match **THIS** IOCCC's `fnamchk` version in order for it
to be valid. If this is not the case your submission **WILL BE** rejected!
- `IOCCC_contest_id` (string)
- `IOCCC_contest_id` (double quoted string)
* The IOCCC contestant ID used as a username in the form of **in the form of
a UUID** and submission number; see the [Rules](next/rules.html) for more details
on this, and in particular [Rule 17](next/rules.html#rule17).
@@ -730,7 +738,7 @@ The file also contains the following details:
violating [Rule 17](next/rules.html#rule17)!
- `tarball` (string)
- `tarball` (double quoted string)
* The xz compressed tarball filename.
**NOTE:** this **MUST** match the actual tarball's **filename** in order for
@@ -792,7 +800,7 @@ The file also contains the following details:
this is not the case `chkentry(1)` will report an **error** and your
submission **WILL BE** rejected!
- `timestamp_epoch` (string)
- `timestamp_epoch` (double quoted string)
* `"Thu Jan 01 00:00:00 1970 UTC"` (`gettimeofday(2)` epoch).
**NOTE:** this **MUST** be `"Thu Jan 01 00:00:00 1970 UTC"` which is `#define`d
@@ -846,7 +854,7 @@ JSON `manifest` array contains information about the files of the submission,
**including** the **mandatory** [.auth.json](#auth_json), [.info.json](#info_json),
C source and [remarks](#remarks) files. In particular:
- `info_JSON` (string)
- `info_JSON` (double quoted string)
* This `MUST` be `".info.json"`, defined as `INFO_JSON_FILENAME` in
[soup/entry_util.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h)
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/), and
@@ -855,7 +863,7 @@ C source and [remarks](#remarks) files. In particular:
**NOTE:** if this is **NOT** the case you stand a great chance of having your
submission rejected for violating [Rule 17](next/rules.html#rule17)!
- `auth_JSON` (string)
- `auth_JSON` (double quoted string)
* This `MUST` be `".auth.json"`, defined as `AUTH_JSON_FILENAME` in
[soup/entry_util.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h)
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/), and
@@ -864,7 +872,7 @@ C source and [remarks](#remarks) files. In particular:
**NOTE:** if this is **NOT** the case you stand a great chance of having your
submission rejected for violating [Rule 17](next/rules.html#rule17)!
- `c_src` (string)
- `c_src` (double quoted string)
* This `MUST` be `"prog.c"`, defined as `PROG_C_FILENAME` in
[soup/entry_util.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h)
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/), and
@@ -877,7 +885,7 @@ C source and [remarks](#remarks) files. In particular:
copied to `prog.c`.
- `Makefile` (string)
- `Makefile` (double quoted string)
* This `MUST` be `"Makefile"`, defined as `MAKEFILE_FILENAME` in
[soup/entry_util.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h)
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/), and
@@ -889,7 +897,7 @@ C source and [remarks](#remarks) files. In particular:
**NOTE:** if you provide to `mkiocccentry` a different filename it will be
copied to `Makefile`.
- `remarks` (string)
- `remarks` (double quoted string)
* This `MUST` be `"remarks.md"`, defined as `REMARKS_FILENAME` in
[soup/entry_util.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/entry_util.h)
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/), and
@@ -904,7 +912,7 @@ C source and [remarks](#remarks) files. In particular:
The `manifest` array also optionally has one or more of the field:
- `extra_file` (string)
- `extra_file` (double quoted string)
* Any additional file that you need or want to include with your submission.
@@ -922,11 +930,19 @@ The `manifest` array also optionally has one or more of the field:
The file also contains the following details:
- `no_comment` (string)
* We can provide `no comment` about `no_comment` so we ask you to please
**NOT** `comment` about our `no comments`. :-)
- `no_comment` (double quoted string)
* We can provide `no comment` about `no_comment` other than to state that unless
`no_comment` matches this quote:
- `IOCCC_info_version` (string)
> "mandatory comment: because comments were removed from the original JSON spec"
your submission **WILL BE** rejected!
Are we suggesting that removing comments from the JSON spec was a mistake?
> "You might very well think that; but of course I couldn't possibly comment." -- Francis Urquhart
- `IOCCC_info_version` (double quoted string)
* The current version of the `.info.json` files.
**NOTE:** this **MUST** match **THIS** IOCCC's `.info.json` version, defined as
@@ -935,7 +951,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `IOCCC_contest` (string)
- `IOCCC_contest` (double quoted string)
* Which contest number this is (e.g. 1 for 1984, 2 for 1985, 27 for 2020).
**NOTE:** this **MUST** match **THIS** IOCCC's contest value, defined as
@@ -956,7 +972,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `mkiocccentry_version` (string)
- `mkiocccentry_version` (double quoted string)
* The version of `mkiocccentry` that formed this `.auth.json` file.
**NOTE:** this **MUST** match **THIS** IOCCC's `mkiocccentry` version,
@@ -965,7 +981,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `iocccsize_version` (string)
- `iocccsize_version` (double quoted string)
* The version of `iocccsize` that was used for this `.info.json` file.
**NOTE:** this **MUST** match **THIS** IOCCC's `iocccentry` version,
@@ -974,7 +990,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `chkentry_version` (string)
- `chkentry_version` (double quoted string)
* The version of `chkentry` that was used to validate this `.info.json`,
assuming that it was created by `mkiocccentry`.
@@ -984,7 +1000,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `fnamchk_version` (string)
- `fnamchk_version` (double quoted string)
* The version of `fnamchk` that `txzchk` uses to validate the filename of
the xz compressed tarball.
@@ -994,7 +1010,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `txzchk_version` (string)
- `txzchk_version` (double quoted string)
* The version of `txzchk` used to validate the xz compressed tarball.
**NOTE:** this **MUST** match **THIS** IOCCC's `txzchk` version, defined
@@ -1003,7 +1019,7 @@ The file also contains the following details:
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/). If
this is not the case your submission **WILL BE** rejected!
- `IOCCC_contest_id` (string)
- `IOCCC_contest_id` (double quoted string)
* The IOCCC contestant ID used as a username in the form of **in the form of
a UUID** and submission number; see the [rules](next/rules.html) for more details
on this, and in particular [Rule 17](next/rules.html#rule17).
@@ -1023,7 +1039,7 @@ The file also contains the following details:
this is not the case you stand a great risk of having your submission
rejected for violating [Rule 17](next/rules.html#rule17)!
- `title` (string)
- `title` (double quoted string)
* A short name (length >= 1 **THROUGH** `MAX_TITLE_LEN`, defined in
[soup/limit_ioccc.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h)
in the [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry/)) that
@@ -1032,7 +1048,7 @@ The file also contains the following details:
**NOTE:** if this is **NOT** the case you stand a great risk of having your submission
rejected for violating [Rule 17](next/rules.html#rule17)!
- `abstract` (string)
- `abstract` (double quoted string)
* A one line summary of your submission, with a length of 1 **THROUGH**
`MAX_ABSTRACT_LEN`, defined in
[soup/limit_ioccc.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h)
@@ -1042,8 +1058,7 @@ The file also contains the following details:
stand a great risk of having your submission rejected for violating [Rule
17](next/rules.html#rule17)!
- `tarball` (string)
- `tarball` (double quoted string)
* The xz compressed tarball filename.
**NOTE:** this **MUST** match the actual tarball's **filename** in order for
@@ -1055,7 +1070,6 @@ The file also contains the following details:
does not mean it's a bug but rather that the directory in the tarball
matches the filename.
- `rule_2a_size` (number)
* The size calculated of [Rule 2a](next/rules.html#rule2a).
@@ -1170,7 +1184,7 @@ The file also contains the following details:
this is not the case `chkentry(1)` will report an **error** and your
submission **WILL BE** rejected!
- `timestamp_epoch` (string)
- `timestamp_epoch` (double quoted string)
* `"Thu Jan 01 00:00:00 1970 UTC"` (`gettimeofday(2)` epoch).
**NOTE:** this **MUST** be `"Thu Jan 01 00:00:00 1970 UTC"` which is `#define`d
@@ -1583,6 +1597,7 @@ By tradition, we do not say.
### FAQ 2.1: What should I put in the remarks.md file of my submission?
</div>
</div>
</div>
First, **PLEASE** read the [IOCCC markdown guidelines](markdown.html).