From 1f81cd44901fdbc19f0c3f85218da4e03865a684 Mon Sep 17 00:00:00 2001
From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com>
Date: Mon, 21 Oct 2024 14:57:07 -0700
Subject: [PATCH] Merge two FAQs about the mkiocccentry toolkit

The new question is 'What is the mkiocccentry tool, how do I obtain it
and how do I use it?'. This one still needs more work, however.
---
 faq.html | 62 ++++++++++++++++++++++++++------------------------------
 faq.md   | 58 +++++++++++++++++++++-------------------------------
 2 files changed, 52 insertions(+), 68 deletions(-)

diff --git a/faq.html b/faq.html
index 7b4168dd4..219e975ba 100644
--- a/faq.html
+++ b/faq.html
@@ -389,15 +389,14 @@
 
 <!-- BEFORE: 1st line of markdown file: faq.md -->
 <h1 id="ioccc-faq-table-of-contents">IOCCC FAQ Table of Contents</h1>
-<p>This is FAQ version <strong>28.1.1 2024-10-21</strong>.</p>
+<p>This is FAQ version <strong>28.1.2 2024-10-21</strong>.</p>
 <h2 id="entering-the-ioccc-the-bare-minimum-you-need-to-know">0. <a href="#enter_questions">Entering the IOCCC: the bare minimum you need to know</a></h2>
 <ul>
 <li><strong>Q 0.0</strong>: <a class="normal" href="#submit">How can I enter the IOCCC?</a></li>
 <li><strong>Q 0.1</strong>: <a class="normal" href="#mkiocccentry">What is the <code>mkiocccentry</code> tool, how do I obtain it and how do I use it?</a></li>
-<li><strong>Q 0.2</strong>: <a class="normal" href="#compile_mkiocccentry">How do I compile <code>mkiocccentry</code> and its related tools?</a></li>
-<li><strong>Q 0.3</strong>: <a class="normal" href="#platform">What platform should I assume for my submission?</a></li>
-<li><strong>Q 0.4</strong>: <a class="normal" href="#makefile">What should I put in my submission Makefile?</a></li>
-<li><strong>Q 0.5</strong>: <a class="normal" href="#remarks">What should I put in the remarks.md file of my submission?</a></li>
+<li><strong>Q 0.2</strong>: <a class="normal" href="#platform">What platform should I assume for my submission?</a></li>
+<li><strong>Q 0.3</strong>: <a class="normal" href="#makefile">What should I put in my submission Makefile?</a></li>
+<li><strong>Q 0.4</strong>: <a class="normal" href="#remarks">What should I put in the remarks.md file of my submission?</a></li>
 </ul>
 <h2 id="entering-the-ioccc-more-help-and-details">1. <a href="#submitting_help">Entering the IOCCC: more help and details</a></h2>
 <ul>
@@ -607,8 +606,12 @@ with the proper instructions. Watch the <a href="news.html">IOCCC news</a>
 for an announcement of the availability of the <strong>IOCCC submit server</strong>.</p>
 <p>Jump to: <a href="#">top</a></p>
 <div id="mkiocccentry">
+<div id="mkiocccentry_compile">
+<div id="compile_mkiocccentry">
 <h3 id="q-0.1-what-is-the-mkiocccentry-tool-how-do-i-obtain-it-and-how-do-i-use-it">Q 0.1: What is the <code>mkiocccentry</code> tool, how do I obtain it and how do I use it?</h3>
 </div>
+</div>
+</div>
 <p>This tool comes from the <a href="https://github.com/ioccc-src/mkiocccentry">mkiocccentry
 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
@@ -623,11 +626,22 @@ have an mkiocccentry tool directory:</p>
 <pre><code>    cd mkiocccentry
     git fetch
     git rebase</code></pre>
+<p>Once you’ve done this, change to the <code>mkiocccentry</code> directory and run
+<code>make clobber all</code> to compile the tools.
+See the
+FAQ on “<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#compiling">compiling mkiocccentry</a>”
+at the <code>mkiocccentry</code> repo if you need more help.</p>
 <p>The <code>mkiocccentry</code> tool first gathers your source
-code, your Makefile, your remarks, other information about your submission,
-information about the author (or authors) and then runs a lot of tests before (if
+code, your Makefile, your remarks, any other data files you wish to provide (up
+to a maximum, including the mandatory files, defined in
+<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h">limit_ioccc.h</a>
+as <code>MAX_FILE_COUNT</code>) and other information about your submission,
+information about the author (or authors), and then runs a lot of tests before (if
 all is OK) forming your tarball. After this is done it will additionally run the
-<code>txzchk(1)</code> tool (which runs the <code>fnamchk(1)</code> tool) on the submission tarball.</p>
+<code>txzchk(1)</code> tool (which runs the <code>fnamchk(1)</code> tool) on the submission tarball.
+The tool <code>chkentry(1)</code> will also be run, before creating the tarball. See the
+FAQ on “<a href="#chkentry">chkentry</a>”
+for more information.</p>
 <p>See the
 FAQ on “<a href="#submit">submitting to the IOCCC</a>”
 for details on how to register for the IOCCC and how to obtain <code>mkiocccentry</code>.</p>
@@ -661,24 +675,6 @@ be the <em>subdirectory</em> with your submission’s files</strong>.</p>
 submission <em>as well as author details</em> (that will only be looked at if the
 submission wins), run some tests and run a number of other tools, as already
 mentioned and as described below.</p>
-<p>Jump to: <a href="#">top</a></p>
-<div id="mkiocccentry_compile">
-<div id="compile_mkiocccentry">
-<h3 id="q-0.2-how-do-i-compile-mkiocccentry-and-its-related-tools">Q 0.2: How do I compile <code>mkiocccentry</code> and its related tools?</h3>
-</div>
-</div>
-<p>After you
-<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#download">download the mkiocccentry
-repo</a> by
-running:</p>
-<pre><code>git clone https://github.com/ioccc-src/mkiocccentry.git</code></pre>
-<p>or downloading the zip file, you should change to the <code>mkiocccentry</code> directory
-so you can compile the tools by running <code>make clobber all</code>. See the
-FAQ on “<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#download">obtaining
-mkiocccentry</a>
-and the
-FAQ on”<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#compiling">compiling mkiocccentry</a>”
-at the <code>mkiocccentry</code> repo.</p>
 <p>See also the
 <a href="https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md">mkiocccentry repo FAQ</a>
 for more up to date information on downloading, compiling, and related FAQ information.</p>
@@ -686,7 +682,7 @@ for more up to date information on downloading, compiling, and related FAQ infor
 <div id="SUS">
 <div id="platform">
 <div id="portability">
-<h3 id="q-0.3-what-platform-should-i-assume-for-my-submission">Q 0.3: What platform should I assume for my submission?</h3>
+<h3 id="q-0.2-what-platform-should-i-assume-for-my-submission">Q 0.2: What platform should I assume for my submission?</h3>
 </div>
 </div>
 </div>
@@ -697,7 +693,7 @@ or <a href="https://unix.org/online.html">later SUS</a>.</p>
 <p>Jump to: <a href="#">top</a></p>
 <div id="makefile">
 <div id="submission_makefile">
-<h3 id="q-0.4-what-should-i-put-in-my-submission-makefile">Q 0.4: What should I put in my submission Makefile?</h3>
+<h3 id="q-0.3-what-should-i-put-in-my-submission-makefile">Q 0.3: What should I put in my submission Makefile?</h3>
 </div>
 </div>
 <p>We recommend starting with the <a href="https://github.com/ioccc-src/mkiocccentry/blob/master/Makefile.example">sample
@@ -3770,9 +3766,9 @@ provided by the author and any other file in the winning entry, found under the
 entry’s subdirectory.</p>
 <p>If you downloaded <code>1984/mullender/1984_mullender.tar.bz2</code>, for instance, you might
 then do:</p>
-<div class="sourceCode" id="cb122"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb122-1"><a href="#cb122-1" aria-hidden="true" tabindex="-1"></a>        <span class="bu">cd</span> 1984/mullender</span>
-<span id="cb122-2"><a href="#cb122-2" aria-hidden="true" tabindex="-1"></a>        <span class="fu">make</span> everything</span>
-<span id="cb122-3"><a href="#cb122-3" aria-hidden="true" tabindex="-1"></a>        <span class="ex">./mullender.alt</span></span></code></pre></div>
+<div class="sourceCode" id="cb121"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb121-1"><a href="#cb121-1" aria-hidden="true" tabindex="-1"></a>        <span class="bu">cd</span> 1984/mullender</span>
+<span id="cb121-2"><a href="#cb121-2" aria-hidden="true" tabindex="-1"></a>        <span class="fu">make</span> everything</span>
+<span id="cb121-3"><a href="#cb121-3" aria-hidden="true" tabindex="-1"></a>        <span class="ex">./mullender.alt</span></span></code></pre></div>
 <p>to compile all versions and then run the alternate version (if you have
 a PDP-11 or VAX-11 you would be able to run the original version). For more help
 on compiling entries, see also the
@@ -3813,8 +3809,8 @@ if you switched to each entry’s directory and ran <code>make everything</code>
 <p>If you download the 1984 tarball, i.e. <code>1984/1984.tar.bz2</code>, then you might
 extract it and then switch to the directory and compile everything of each
 entry:</p>
-<div class="sourceCode" id="cb123"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb123-1"><a href="#cb123-1" aria-hidden="true" tabindex="-1"></a>        <span class="bu">cd</span> 1984</span>
-<span id="cb123-2"><a href="#cb123-2" aria-hidden="true" tabindex="-1"></a>        <span class="fu">make</span> everything</span></code></pre></div>
+<div class="sourceCode" id="cb122"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb122-1"><a href="#cb122-1" aria-hidden="true" tabindex="-1"></a>        <span class="bu">cd</span> 1984</span>
+<span id="cb122-2"><a href="#cb122-2" aria-hidden="true" tabindex="-1"></a>        <span class="fu">make</span> everything</span></code></pre></div>
 <p>For more help on compiling entries, see also the
 FAQ on “<a href="#make_rules">IOCCC Makefile rules</a>”.</p>
 <p>Of course in this case you can also switch to individual entries and look at the
diff --git a/faq.md b/faq.md
index 6e120cf6a..81cf663a6 100644
--- a/faq.md
+++ b/faq.md
@@ -1,15 +1,14 @@
 # IOCCC FAQ Table of Contents
 
-This is FAQ version **28.1.1 2024-10-21**.
+This is FAQ version **28.1.2 2024-10-21**.
 
 
 ## 0. [Entering the IOCCC: the bare minimum you need to know](#enter_questions)
 - **Q 0.0**: <a class="normal" href="#submit">How can I enter the IOCCC?</a>
 - **Q 0.1**: <a class="normal" href="#mkiocccentry">What is the `mkiocccentry` tool, how do I obtain it and how do I use it?</a>
-- **Q 0.2**: <a class="normal" href="#compile_mkiocccentry">How do I compile `mkiocccentry` and its related tools?</a>
-- **Q 0.3**: <a class="normal" href="#platform">What platform should I assume for my submission?</a>
-- **Q 0.4**: <a class="normal" href="#makefile">What should I put in my submission Makefile?</a>
-- **Q 0.5**: <a class="normal" href="#remarks">What should I put in the remarks.md file of my submission?</a>
+- **Q 0.2**: <a class="normal" href="#platform">What platform should I assume for my submission?</a>
+- **Q 0.3**: <a class="normal" href="#makefile">What should I put in my submission Makefile?</a>
+- **Q 0.4**: <a class="normal" href="#remarks">What should I put in the remarks.md file of my submission?</a>
 
 
 ## 1. [Entering the IOCCC: more help and details](#submitting_help)
@@ -271,8 +270,12 @@ Jump to: [top](#)
 
 
 <div id="mkiocccentry">
+<div id="mkiocccentry_compile">
+<div id="compile_mkiocccentry">
 ### Q 0.1: What is the `mkiocccentry` tool, how do I obtain it and how do I use it?
 </div>
+</div>
+</div>
 
 This tool comes from the [mkiocccentry
 repo](https://github.com/ioccc-src/mkiocccentry) and it is **required** that you
@@ -297,12 +300,23 @@ If you already have an mkiocccentry tool directory:
     git rebase
 ```
 
+Once you've done this, change to the `mkiocccentry` directory and run
+`make clobber all` to compile the tools.
+See the
+FAQ on "[compiling mkiocccentry](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#compiling)"
+at the `mkiocccentry` repo if you need more help.
 
 The `mkiocccentry` tool first gathers your source
-code, your Makefile, your remarks, other information about your submission,
-information about the author (or authors) and then runs a lot of tests before (if
+code, your Makefile, your remarks, any other data files you wish to provide (up
+to a maximum, including the mandatory files, defined in
+[limit_ioccc.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h)
+as `MAX_FILE_COUNT`) and other information about your submission,
+information about the author (or authors), and then runs a lot of tests before (if
 all is OK) forming your tarball. After this is done it will additionally run the
 `txzchk(1)` tool (which runs the `fnamchk(1)` tool) on the submission tarball.
+The tool `chkentry(1)` will also be run, before creating the tarball. See the
+FAQ on "[chkentry](#chkentry)"
+for more information.
 
 See the
 FAQ on "[submitting to the IOCCC](#submit)"
@@ -348,32 +362,6 @@ submission _as well as author details_ (that will only be looked at if the
 submission wins), run some tests and run a number of other tools, as already
 mentioned and as described below.
 
-Jump to: [top](#)
-
-
-<div id="mkiocccentry_compile">
-<div id="compile_mkiocccentry">
-### Q 0.2: How do I compile `mkiocccentry` and its related tools?
-</div>
-</div>
-
-After you
-[download the mkiocccentry
-repo](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#download) by
-running:
-
-``` <!---sh-->
-git clone https://github.com/ioccc-src/mkiocccentry.git
-```
-
-or downloading the zip file, you should change to the `mkiocccentry` directory
-so you can compile the tools by running `make clobber all`. See the
-FAQ on "[obtaining
-mkiocccentry](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#download)
-and the
-FAQ on "[compiling mkiocccentry](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#compiling)"
-at the `mkiocccentry` repo.
-
 See also the
 [mkiocccentry repo FAQ](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md)
 for more up to date information on downloading, compiling, and related FAQ information.
@@ -384,7 +372,7 @@ Jump to: [top](#)
 <div id="SUS">
 <div id="platform">
 <div id="portability">
-### Q 0.3: What platform should I assume for my submission?
+### Q 0.2: What platform should I assume for my submission?
 </div>
 </div>
 </div>
@@ -399,7 +387,7 @@ Jump to: [top](#)
 
 <div id="makefile">
 <div id="submission_makefile">
-### Q 0.4: What should I put in my submission Makefile?
+### Q 0.3: What should I put in my submission Makefile?
 </div>
 </div>