Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add details on submitting extra files #55

Merged
merged 2 commits into from
Jan 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ <h2>Frequently Asked Questions</h2>

<!-- 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.2.0 2025-01-16</strong>.</p>
<p>This is FAQ version <strong>28.2.1 2025-01-18</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="#enter">How can I enter the IOCCC?</a></li>
Expand All @@ -448,7 +448,8 @@ <h2 id="entering-the-ioccc-more-help-and-details">1. <a href="#submitting_help">
<li><strong>Q 1.2</strong>: <a class="normal" href="#markdown">What is markdown and how does the IOCCC use it?</a></li>
<li><strong>Q 1.3</strong>: <a class="normal" href="#mkiocccentry_bugs">How do I report bugs in an <code>mkiocccentry</code> tool?</a></li>
<li><strong>Q 1.4</strong>: <a class="normal" href="#subdirectories">How may I use subdirectories in my submission if Rule 17 disallows them?</a></li>
<li><strong>Q 1.5</strong>: <a class="normal" href="#mkiocccentry_test">How can I test my submission passes tests without having to answer questions?</a></li>
<li><strong>Q 1.5</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.6</strong>: <a class="normal" href="#extra-files">How may I include additional files beyond the max allowed?</a></li>
</ul>
<h2 id="ioccc-judging-process">2. <a href="#judging">IOCCC Judging process</a></h2>
<ul>
Expand Down Expand Up @@ -967,7 +968,7 @@ <h4 id="q-1.4-how-may-i-use-subdirectories-in-my-submission-if-rule-17-disallows
<a href="https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h">limit_ioccc.h</a>,
you can include tarballs with subdirectories or other files.</p>
<div id="mkiocccentry_test">
<h4 id="q-1.5-how-can-i-test-my-submission-passes-tests-without-having-to-answer-questions">Q 1.5: How can I test my submission passes tests without having to answer questions?</h4>
<h4 id="q-1.5-how-can-i-check-if-my-submission-passes-tests-without-having-to-answer-questions">Q 1.5: How can I check if my submission passes tests without having to answer questions?</h4>
</div>
<p>In case you do not have a UUID or you simply want to test if <code>mkiocccentry(1)</code>
does not detect any issues with your submission, without having to answer all
Expand All @@ -991,6 +992,25 @@ <h4 id="q-1.5-how-can-i-test-my-submission-passes-tests-without-having-to-answer
and the
FAQ on “<a href="#fnamchk">fnamchk</a>”
for more details.</p>
<div id="extra-files">
<h1 id="how-may-i-include-additional-files-beyond-the-max-allowed">How may I include additional files beyond the max allowed?</h1>
</div>
<p>The rules state:</p>
<blockquote>
<p>The maximum number of files your submission tarball may contain, not counting
the optional files (<code>prog.alt.c</code>, <code>try.sh</code>, <code>try.alt.sh</code>) and the mandatory
files (<code>prog.c</code>, <code>Makefile</code>, <code>remarks.md</code>) is 31.</p>
</blockquote>
<p>If you need to include more files than this, you may include a tarball as an
<strong>EXTRA</strong> file.</p>
<p>This file does <strong>NOT</strong> need to pass the <code>txzchk(1)</code> tests; only your submission
tarball needs to pass these tests.</p>
<p>Please pay careful attention to <a href="next/rules.html#rule17">Rule 17</a> and in
particular the part about the <a href="next/rules.html#max-files">maximum number of files per
submission</a>, which not only discusses the maximum
number of files (including extra 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#rule17">Rule 17</a>!</p>
<hr style="width:50%;text-align:left;margin-left:0">
<hr style="width:50%;text-align:left;margin-left:0">
<div id="judging">
Expand Down
30 changes: 27 additions & 3 deletions faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# IOCCC FAQ Table of Contents

This is FAQ version **28.2.0 2025-01-16**.
This is FAQ version **28.2.1 2025-01-18**.


## 0. [Entering the IOCCC: the bare minimum you need to know](#enter_questions)
Expand All @@ -22,7 +22,8 @@ This is FAQ version **28.2.0 2025-01-16**.
- **Q 1.2**: <a class="normal" href="#markdown">What is markdown and how does the IOCCC use it?</a>
- **Q 1.3**: <a class="normal" href="#mkiocccentry_bugs">How do I report bugs in an `mkiocccentry` tool?</a>
- **Q 1.4**: <a class="normal" href="#subdirectories">How may I use subdirectories in my submission if Rule 17 disallows them?</a>
- **Q 1.5**: <a class="normal" href="#mkiocccentry_test">How can I test my submission passes tests without having to answer questions?</a>
- **Q 1.5**: <a class="normal" href="#mkiocccentry_test">How can I check if my submission passes tests without having to answer questions?</a>
- **Q 1.6**: <a class="normal" href="#extra-files">How may I include additional files beyond the max allowed?</a>


## 2. [IOCCC Judging process](#judging)
Expand Down Expand Up @@ -662,7 +663,7 @@ tarball does not exceed the limit, defined as `MAX_FILE_COUNT` in
you can include tarballs with subdirectories or other files.

<div id="mkiocccentry_test">
#### Q 1.5: How can I test my submission passes tests without having to answer questions?
#### Q 1.5: How can I check if my submission passes tests without having to answer questions?
</div>

In case you do not have a UUID or you simply want to test if `mkiocccentry(1)`
Expand Down Expand Up @@ -696,6 +697,29 @@ FAQ on "[fnamchk](#fnamchk)"
for more details.


<div id="extra-files">
# How may I include additional files beyond the max allowed?
</div>

The rules state:

> The maximum number of files your submission tarball may contain, not counting
the optional files (`prog.alt.c`, `try.sh`, `try.alt.sh`) and the mandatory
files (`prog.c`, `Makefile`, `remarks.md`) is 31.

If you need to include more files than this, you may include a tarball as an
**EXTRA** file.

This file does **NOT** need to pass the `txzchk(1)` tests; only your submission
tarball needs to pass these tests.

Please pay careful attention to [Rule 17](next/rules.html#rule17) and in
particular the part about the [maximum number of files per
submission](next/rules.html#max-files), which not only discusses the maximum
number of files (including extra 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 [Rule 17](next/rules.html#rule17)!

<hr style="width:50%;text-align:left;margin-left:0">
<hr style="width:50%;text-align:left;margin-left:0">

Expand Down
42 changes: 39 additions & 3 deletions next/guidelines.html
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ <h1 id="ioccc-guidelines-version">IOCCC Guidelines version</h1>
</div>
</div>
<p class="leftbar">
These <a href="guidelines.html">IOCCC guidelines</a> are version <strong>28.30 2025-01-16</strong>.
These <a href="guidelines.html">IOCCC guidelines</a> are version <strong>28.31 2025-01-18</strong>.
</p>
<p class="leftbar">
The <a href="guidelines.md" download="guidelines.md">markdown form of these guidelines</a>
Expand Down Expand Up @@ -561,7 +561,7 @@ <h1 id="whats-new-this-ioccc">WHAT’S NEW THIS IOCCC</h1>
you should <strong>MAKE SURE</strong> you give yourself enough time before the contest closes.
In other words, <strong>DO NOT WAIT UNTIL THE FINAL DAYS</strong> of the contest to register!
The <a href="../judges.html">IOCCC judges</a> are <strong>NOT</strong> responsible for delayed or lost email,
nor for those who wait until the last minute to try to register!
or for those who wait until the last minute to try to register!
</p>
<p class="leftbar">
For those who have <a href="register.html">registered</a> and received by email, their
Expand Down Expand Up @@ -648,7 +648,7 @@ <h1 id="whats-new-this-ioccc">WHAT’S NEW THIS IOCCC</h1>
as that FAQ has import details on
<a href="register.html">how to register</a>
as well as
<a href="submit.html">how to upload your submission</a> for the IOCCC.
<a href="submit.html">how to upload your submission</a> to the IOCCC.
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="hints">
Expand Down Expand Up @@ -786,6 +786,36 @@ <h1 id="hints-and-suggestions">HINTS AND SUGGESTIONS:</h1>
<a href="../faq.html#size_rule2013-2020">2013-2020</a> IOCCC eras.
</p>
<p>Jump to: <a href="#">top</a></p>
<div id="extra-files">
<h1 id="including-extra-files">Including extra files</h1>
</div>
<p class="leftbar">
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
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
specific file(name)s: the <strong>OPTIONAL</strong> submission files, which are <code>prog.alt.c</code>,
<code>try.sh</code> and <code>try.alt.sh</code>, or else they <strong>WILL</strong> count as an extra file.
</p>
<p class="leftbar">
In other words, the actual amount of <strong>EXTRA</strong> files is 31.
</p>
<p class="leftbar">
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
submission tarball must pass the <code>txzchk(1)</code> tests.
<p class="leftbar">
<p class="leftbar">
<p>See <a href="rules.html#rule17">Rule 17</a> and in particular the part about the <a href="rules.html#max-files">maximum
number of files</a>. If you do not follow these points, you
are at a great risk of violating <a href="rules.html#rule17">Rule 17</a>!</p>
<p class="leftbar">
<p>For more details, see the
FAQ on the “<a href="../faq.html#try">try.sh script system</a>”,
the
FAQ on “<a href="../faq.html#auth_json">.auth.json</a>”,
the
FAQ on “<a href="../faq.html#info_json">.info.json</a>”,</p>
<h1 id="mkiocccentry"><code>mkiocccentry</code></h1>
<p class="leftbar">
<a href="rules.html#rule17">Rule 17</a> (the <code>mkiocccentry(1)</code> rule) states that
Expand Down Expand Up @@ -1413,6 +1443,12 @@ <h1 id="our-likes-and-dislikes">OUR LIKES AND DISLIKES:</h1>
<p class="leftbar">
We <strong>DISLIKE</strong> the use of <code>gets(3)</code>. Use <code>fgets(3)</code> instead.
</p>
<p class="leftbar">
We tend to <strong>DISLIKE</strong> the blatant use of tarballs in an attempt to simply get
around the extra file number limit. We realize there may be cases where a
tarball containing a number of extra files may be needed. Such a need for a
tarball <strong>MUST</strong> be explained in the <code>remarks.md</code> file.
</p>
<p>On 28 January 2007, the Judges rescinded the requirement that the
<code>#</code> in a C preprocessor directive must be the 1st non-whitespace octet.</p>
<p>The <code>exit(3)</code> function returns <code>void</code>. Some broken systems have <code>exit(3)</code>
Expand Down
50 changes: 47 additions & 3 deletions next/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Jump to: [top](#)
</div>

<p class="leftbar">
These [IOCCC guidelines](guidelines.html) are version **28.30 2025-01-16**.
These [IOCCC guidelines](guidelines.html) are version **28.31 2025-01-18**.
</p>

<p class="leftbar">
Expand Down Expand Up @@ -174,7 +174,7 @@ to process your registration and email you your initial login and password,
you should **MAKE SURE** you give yourself enough time before the contest closes.
In other words, **DO NOT WAIT UNTIL THE FINAL DAYS** of the contest to register!
The [IOCCC judges](../judges.html) are **NOT** responsible for delayed or lost email,
nor for those who wait until the last minute to try to register!
or for those who wait until the last minute to try to register!
</p>

<p class="leftbar">
Expand Down Expand Up @@ -281,7 +281,7 @@ FAQ on "[how to enter the IOCCC](../quick-start.html#enter)"
as that FAQ has import details on
[how to register](register.html)
as well as
[how to upload your submission](submit.html) for the IOCCC.
[how to upload your submission](submit.html) to the IOCCC.
</p>


Expand Down Expand Up @@ -452,6 +452,43 @@ value similar to the [2001-2012](../faq.html#size_rule2001-2012) and

Jump to: [top](#)

<div id="extra-files">
# Including extra files
</div>

<p class="leftbar">
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
the two JSON files generated by `mkiocccentry(1)`, `.info.json` and
`.auth.json`). Additionally, three of the files in the limit **MUST** be
specific file(name)s: the **OPTIONAL** submission files, which are `prog.alt.c`,
`try.sh` and `try.alt.sh`, or else they **WILL** count as an extra file.
</p>

<p class="leftbar">
In other words, the actual amount of **EXTRA** files is 31.
</p>

<p class="leftbar">
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
submission tarball must pass the `txzchk(1)` tests.
<p class="leftbar">

<p class="leftbar">
See [Rule 17](rules.html#rule17) and in particular the part about the [maximum
number of files](rules.html#max-files). If you do not follow these points, you
are at a great risk of violating [Rule 17](rules.html#rule17)!

<p class="leftbar">
For more details, see the
FAQ on the "[try.sh script system](../faq.html#try)",
the
FAQ on "[.auth.json](../faq.html#auth_json)",
the
FAQ on "[.info.json](../faq.html#info_json)",


<div id="mkiocccentry">
# `mkiocccentry`
</div>
Expand Down Expand Up @@ -1251,6 +1288,13 @@ We **DISLIKE** the use of `varargs.h`. Use `stdarg.h` instead.
We **DISLIKE** the use of `gets(3)`. Use `fgets(3)` instead.
</p>

<p class="leftbar">
We tend to **DISLIKE** the blatant use of tarballs in an attempt to simply get
around the extra file number limit. We realize there may be cases where a
tarball containing a number of extra files may be needed. Such a need for a
tarball **MUST** be explained in the `remarks.md` file.
</p>

On 28 January 2007, the Judges rescinded the requirement that the
`#` in a C preprocessor directive must be the 1st non-whitespace octet.

Expand Down
Loading
Loading