add FAQ for IOCCC terms Author, Entry, and Submission

2024-02-25 01:17:05 -08:00
1 parent ddb6c288b5
commit 120869a4b2
@@ -236,6 +236,8 @@ are they used?</a></li>
 <li><a href="#faq6_7">6.7 - What is a entry_id?</a></li>
 <li><a href="#faq6_8">6.8 - What is the purpose of the .top, .year and
 .path files?</a></li>
 <li><a href="#faq6_9">6.9 - What is the current meaning of the IOCCC
 terms Author, Entry, and Submission?</a></li>
 </ul>
 <h1 id="the-ioccc-faq">The IOCCC FAQ</h1>
 <h2
@@ -2614,6 +2616,66 @@ href="/1984/anonymous/.path">1984/anonymous/.path</a>.</p>
 Makefile, by:</p>
 <div class="sourceCode" id="cb104"><pre
 class="sourceCode sh"><code class="sourceCode bash"><span id="cb104-1"><a href="#cb104-1" aria-hidden="true" tabindex="-1"></a><span class="fu">make</span> genpath</span></code></pre></div>
 <h3
 id="faq-6.9-what-is-the-current-meaning-of-the-ioccc-terms-author-entry-and-submission"><a name="faq6_9"></a>FAQ
 6.9: What is the current meaning of the IOCCC terms Author, Entry, and
 Submission?</h3>
 <p>The IOCCC is now attempting to use the following terms:</p>
 <ul>
 <li>Author</li>
 </ul>
 <p>An <em>author</em> is someone who has submitted an entry that has won
 the IOCCC.</p>
 <p>An entry can have more than one authors. A number of authors have
 submitted entries that have won the IOCCC, sometimes in the same IOCCC
 contest year.</p>
 <p><strong>An apology for being inconsistent</strong>: In the past, the
 IOCCC used the term <em>winner</em> to refer to what is now an
 <em>author</em>. In a number of historical cases, such as old rules and
 old guidelines, terms such as <em>winner</em> may still be found.
 Moreover, out of habit, the IOCCC judges sometimes use old names such as
 <em>winner</em> when they should use <em>author</em>. Sorry (tm Canada)!
 :-)</p>
 <ul>
 <li>Entry</li>
 </ul>
 <p>An <em>entry</em> is a submission that won the IOCCC.</p>
 <p>An <em>entry</em> has one or more <em>authors</em>.</p>
 <p>An <em>entry</em> includes all of the files needed to compile it,
 plus sample input files, a <code>Makefile</code>, an
 <code>.entry.json</code> file describing the entry, a compressed tarball
 containing all of files in the entry, etc. Under the IOCCC tree, an
 <em>entry</em> that win the IOCCC in year <em>YYYY</em> is located under
 the directory <code>YYYY/entry</code>.</p>
 <p><strong>An apology for being inconsistent</strong>: In the past, the
 IOCCC used the term <em>winner</em> to refer to what is now an
 <em>entry</em>. In a number of historical cases, such as old rules and
 old guidelines, terms such as <em>winner</em> may still be found.
 Moreover, out of habit, the IOCCC judges sometimes use old names such as
 <em>winner</em> when they should use <em>entry</em>. Sorry (tm Canada)!
 :-)</p>
 <ul>
 <li>Submission</li>
 </ul>
 <p>A <em>submission</em> is something given to the IOCCC judges for
 consideration when the IOCCC is open.</p>
 <p>When the IOCCC is open for submissions, those who register to enter
 the IOCCC may use the <a
 href="https://github.com/ioccc-src/mkiocccentry">mkliocccentry tool</a>
 to package their code into a compressed tarball that may be uploaded to
 the <a href="https://submit.ioccc.org">IOCCC submit server</a>. This
 compressed tarball is formatted in such a way that the IOCCC judges do
 not see who wrote the code.</p>
 <p>A <em>submission</em> that the IOCCC judges deem to have won the
 IOCCC becomes an <em>entry</em>. Only then do the IOCCC judges look into
 the special JSON file to discover who the <em>author</em>(s) are.</p>
 <p><strong>An apology for being inconsistent</strong>: In the past, the
 IOCCC used the term <em>entry</em> to refer to what is now an
 <em>submission</em>. In a number of historical cases, such as old rules
 and old guidelines, terms such as <em>entry</em> may still be found.
 Moreover, out of habit, the IOCCC judges sometimes use old names such as
 <em>entry</em> when they should use <em>submission</em>. Sorry (tm
 Canada)! :-)</p>
 <!-- END: this line ends content for HTML phase 21 by: bin/pandoc-wrapper.sh via bin/md2html.sh -->
 <!-- START: this line starts content from: inc/after-content.default.html -->
@@ -71,6 +71,7 @@ other inconsistencies with the original entry?](#faq4_3)
 - [6.6  - What is a author_handle.json file and how are they used?](#faq6_6)
 - [6.7  - What is a entry_id?](#faq6_7)
 - [6.8 -  What is the purpose of the .top, .year and .path files?](#faq6_8)
 - [6.9 -  What is the current meaning of the IOCCC terms Author, Entry, and Submission?](#faq6_9)
 # The IOCCC FAQ
@@ -2941,3 +2942,62 @@ The .top, .year and .path files are generated from the top level Makefile, by:
 ```sh
 make genpath
 ```
 ### <a name="faq6_9"></a>FAQ 6.9: What is the current meaning of the IOCCC terms Author, Entry, and Submission?
 The IOCCC is now attempting to use the following terms:
 - Author
 An _author_ is someone who has submitted an entry that has won the IOCCC.
 An entry can have more than one authors.  A number of authors have submitted
 entries that have won the IOCCC, sometimes in the same IOCCC contest year.
 **An apology for being inconsistent**: In the past, the IOCCC used the term _winner_ to
 refer to what is now an _author_.  In a number of historical cases,
 such as old rules and old guidelines, terms such as _winner_ may still be
 found.  Moreover, out of habit, the IOCCC judges sometimes use old
 names such as _winner_ when they should use _author_.  Sorry (tm Canada)! :-)
 - Entry
 An _entry_ is a submission that won the IOCCC.
 An _entry_ has one or more _authors_.
 An _entry_ includes all of the files needed to compile it,
 plus sample input files, a `Makefile`, an `.entry.json` file
 describing the entry, a compressed tarball containing all of
 files in the entry, etc.  Under the IOCCC tree, an _entry_
 that win the IOCCC in year _YYYY_ is located under the
 directory `YYYY/entry`.
 **An apology for being inconsistent**: In the past, the IOCCC used the term _winner_ to
 refer to what is now an _entry_.  In a number of historical cases,
 such as old rules and old guidelines, terms such as _winner_ may still be
 found.  Moreover, out of habit, the IOCCC judges sometimes use old
 names such as _winner_ when they should use _entry_.  Sorry (tm Canada)! :-)
 - Submission
 A _submission_ is something given to the IOCCC judges
 for consideration when the IOCCC is open.
 When the IOCCC is open for submissions, those who register
 to enter the IOCCC may use the [mkliocccentry tool](https://github.com/ioccc-src/mkiocccentry)
 to package their code into a compressed tarball that may be
 uploaded to the [IOCCC submit server](https://submit.ioccc.org).
 This compressed tarball is formatted in such a way that
 the IOCCC judges do not see who wrote the code.
 A _submission_ that the IOCCC judges deem to have won the IOCCC
 becomes an _entry_.  Only then do the IOCCC judges look into
 the special JSON file to discover who the _author_(s) are.
 **An apology for being inconsistent**: In the past, the IOCCC used the term _entry_ to
 refer to what is now an _submission_.  In a number of historical cases,
 such as old rules and old guidelines, terms such as _entry_ may still be
 found.  Moreover, out of habit, the IOCCC judges sometimes use old
 names such as _entry_ when they should use _submission_.  Sorry (tm Canada)! :-)