Skip to content

Commit

Permalink
resolve issue #57
Browse files Browse the repository at this point in the history 
Moved information about the fields of `status.json` to FAQ 10.11.
  • Loading branch information
@lcn2
lcn2 committed Mar 1, 2025
1 parent 8d2d6ee commit fadb1dd
Show file tree
Hide file tree
Showing 19 changed files with 512 additions and 490 deletions.
121 changes: 120 additions & 1 deletion faq.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ <h2 id="entering-the-ioccc-more-help-and-details">1. <a href="#submitting_help">
<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>
<h2 id="ioccc-judging-process">2. <a href="#judging_proceess">IOCCC Judging process</a></h2>
<ul>
<li><strong>Q 2.0</strong>: <a class="normal" href="#questions">What is the best way to ask a question about the IOCCC rules, guideline and tools?</a></li>
<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>
Expand Down Expand Up @@ -562,6 +562,7 @@ <h2 id="miscellaneous-ioccc">10. <a href="#misc">Miscellaneous IOCCC</a></h2>
<li><strong>Q 10.8</strong>: <a class="normal" href="#menus">How do the menus on the website work and what can I do if they don’t work?</a></li>
<li><strong>Q 10.9</strong>: <a class="normal" href="#author-information">How do I find more information about a winning author of an entry?</a></li>
<li><strong>Q 10.10</strong>: <a class="normal" href="#cb">What is this cb tool that is mentioned in the IOCCC?</a></li>
<li><strong>Q 10.11</strong>: <a class="normal" href="status_json">What do the status.json JSON file indicate?</a></li>
</ul>
<h2 id="history-of-the-ioccc">11. <a href="#ioccc_history">History of the IOCCC</a></h2>
<ul>
Expand Down Expand Up @@ -5560,6 +5561,124 @@ <h3 id="q-10.10-what-is-this-cb-tool-that-is-mentioned-in-the-ioccc">Q 10.10: Wh
judging the IOCCC. A Unix man page for <code>cb</code>
<a href="https://www.ibm.com/docs/en/aix/7.3?topic=c-cb-command">still exists</a>.</p>
<p>Jump to: <a href="#">top</a></p>
<div id="status_json">
<h3 id="q-10.11-what-do-the-status.json-json-file-indicate">Q 10.11: What do the status.json JSON file indicate?</h3>
</div>
<p>The following <strong>JSON</strong> members are required to be present <a href="status.json">status.json</a>.</p>
<div id="no_comment">
<h2 id="no_comment-2">no_comment</h2>
</div>
<p>This is a <strong>mandatory</strong> comment for which we offer no comment other
than this comment. :-)</p>
<p>The <strong>JSON</strong> member value must be the following <strong>JSON</strong> quoted string:</p>
<pre><code> &quot;mandatory comment: because comments were removed from the original JSON spec&quot;</code></pre>
<div id="IOCCC_status_version">
<h2 id="ioccc_status_version">IOCCC_status_version</h2>
</div>
<p>This is the version of format of the <a href="status.json">status.json</a> file.</p>
<p>The <strong>JSON</strong> member value of is a <strong>JSON</strong> quoted string the form “<em>version YYYY-MM-DD</em>”.</p>
<p>This document describes version “<strong>1.0 2024-03-09</strong>”.</p>
<h2 id="contest_status">contest_status</h2>
<p>This is the current status of the contest.</p>
<p>The following <strong>JSON</strong> member value string may be one of the following <strong>JSON</strong> quoted strings:</p>
<h4 id="pending">“<strong>pending</strong>”</h4>
<p>While the contest <strong><a href="#pending">PENDING</a></strong> the contest is not yet <a href="#open">open</a>, however there is a tentative scheduled
date and time by which the contest will <a href="#open">open</a> for submissions.</p>
<p>A preliminary <a href="next/rules.html">IOCCC rules</a>, <a href="next/guidelines.html">IOCCC guidelines</a>,
and <a href="https://github.com/ioccc-src/mkiocccentry">IOCCC mkiocccentry tools</a> have
been released.</p>
<p>You may <a href="next/register.html">register for the IOCCC</a> while the contest is <a href="#pending">pending</a>,
however you will <strong>NOT</strong> receive your own Email message containing your very own
<strong>Username and Initial Password until the contest is <a href="#open">open</a></strong>. You will need these
to be able to <a href="next/submit.html">upload your submission</a> to the <a href="https://submit.ioccc.org">IOCCC submit
server</a>.</p>
<p>Once contest moves from <a href="#pending%22">pending</a> to <a href="#open">open</a>, an announcement
Email will be sent out to the mailing list of those have successfully registered for the IOCCC.
In addition, an announcement will be made to the <a href="news.html">IOCCC news</a> in case you miss
that announcement Email.</p>
<p>While you are waiting for the contest to <a href="#open">open</a>, we <strong>highly recommend</strong>
that you review the <a href="next/rules.html">IOCCC rules</a>, <a href="next/guidelines.html">IOCCC guidelines</a>,
and <a href="https://github.com/ioccc-src/mkiocccentry">IOCCC mkiocccentry tools</a>.</p>
<p>Should you have any comments, suggestions, and concerns about the above, and <strong>while you waiting</strong>
for the contest to <a href="#open">open</a>, please see the
FAQ on “<a href="#feedback">comment or make a suggestion on IOCCC rules, guidelines and tools</a>”
as well as the
FAQ on “<a href="#questions">best way to ask a question about the IOCCC rules, guideline and tools</a>”
for how.</p>
<p>See also the
FAQ on “<a href="next/submit.html">how to upload your submission</a>”
for more information on the submission process when the IOCCC <a href="#open">reopens</a>.</p>
<h4 id="open">“<strong>open</strong>”</h4>
<p>While contest is <strong><a href="#open">OPEN</a></strong>, those who have <a href="next/register.html">registered for the IOCCC</a>
may <a href="next/submit.html">upload their submissions</a> to the <a href="https://submit.ioccc.org">IOCCC submit server</a>.</p>
<p>See the
FAQ on “<a href="#submit">how to submit</a>”
for more information.</p>
<p>See the <a href="news.html">IOCCC news</a> page for details on any IOCCC related deadlines
such as when the contest will <a href="#closed">close</a>.</p>
<p>The <a href="next/rules.html">IOCCC rules</a>, <a href="next/guidelines.html">IOCCC guidelines</a>,
and <a href="https://github.com/ioccc-src/mkiocccentry">IOCCC mkiocccentry tools</a>
are now official. Should you have any questions about these, please see the
FAQ on “<a href="#questions">best way to ask a question about the IOCCC rules, guideline and tools</a>”
for how to ask them.</p>
<p>Be sure to review the official <a href="next/rules.html">IOCCC rules</a>, <a href="next/guidelines.html">IOCCC guidelines</a>,
for any changes, as well as updating your <a href="https://github.com/ioccc-src/mkiocccentry">IOCCC mkiocccentry tools</a>
as changes to them may have been made while the contest was “<strong><a href="#pending">pending</a></strong>”.</p>
<p>See also the
FAQ on “<a href="#submit">how to submit</a>”
for more information on the submission process when the IOCCC <a href="#open">reopens</a>.</p>
<h4 id="judging">“<strong>judging</strong>”</h4>
<p>While contest is <strong><a href="#judging">JUDGING</a></strong>, you cannot <a href="next/register.html">register</a>
nor can you <a href="next/submit.html">upload submissions</a>. This is because the
<a href="judges.html">IOCCC judges</a> are in the process of judging the <a href="#how_many">submissions</a>
they received while the contest was <a href="#open">open</a>.</p>
<p>Watch the <a href="https://fosstodon.org/@ioccc"><span class="citation" data-cites="IOCCC">@IOCCC</span> mastodon feed</a> for updates.</p>
<p>Once the contest <a href="#closed">closes</a>, the judges will:</p>
<ul>
<li><p>Select the <a href="years.html">winning entries</a> and announce them on the <a href="https://fosstodon.org/@ioccc"><span class="citation" data-cites="IOCCC">@IOCCC</span>
mastodon feed</a>.</p></li>
<li><p>Notify the <a href="authors.html">authors</a> of entries that won the contest
via email using their registered email address.</p></li>
<li><p>Announce who the <a href="authors.html">authors</a> are of this year’s <a href="years.html">winning IOCCC
entries</a> via the <a href="https://fosstodon.org/@ioccc"><span class="citation" data-cites="IOCCC">@IOCCC</span> mastodon
feed</a>.</p></li>
<li><p>Upload the winning code to the <a href="https://github.com/ioccc-src/winner">Official IOCCC winner
repo</a>.</p></li>
<li><p>Update the <a href="index.html">Official IOCCC website</a>, and in particular
display this year’s <a href="years.html">winning IOCCC entries</a> at the top of the <a href="years.html">IOCCC
winning entries page</a>.</p></li>
<li><p>Update the <a href="news.html">IOCCC news</a> page.</p></li>
</ul>
<h4 id="closed">“<strong>closed</strong>”</h4>
<p>While contest is <strong><a href="#closed">CLOSED</a></strong>, you cannot <a href="next/register.html">register</a>
nor can you <a href="next/submit.html">upload submissions</a>. You have to wait for the
next contest to <a href="#open">open</a>.</p>
<p>See the <a href="years.html">IOCCC winning entries page</a> for the entries that have won
the <a href="index.html">IOCCC</a>.</p>
<p><strong>NOTE</strong>: From time to time, <a href="years.html">winning IOCCC entries</a> may have their write-ups updated,
<code>Makefiles</code> improved, source code fixed etc. See <a href="news.html">IOCCC news</a> for details.</p>
<p>Watch both <a href="status.html">this IOCCC status page</a> and the <a href="https://fosstodon.org/@ioccc"><span class="citation" data-cites="IOCCC">@IOCCC</span>
mastodon feed</a> for information about future
contest <a href="#open">openings</a>.</p>
<h2 id="news_update">news_update</h2>
<p>This shows the latest modification date for the <a href="news.html">IOCCC news</a> page.</p>
<p>The <strong>JSON</strong> member value is a <strong>JSON</strong> quoted string obtained from the date field
of the following <code>ls(1)</code> command:</p>
<pre><code> TZ=UTC ls -D &#39;%FT%T+00:00&#39; -ld news.html</code></pre>
<p><strong>NOTE</strong>: The date and time are given with respect to <strong>UTC</strong> timezone.</p>
<p><strong>NOTE</strong>: It is possible that for some reason, the <a href="news.html">IOCCC news</a> page
was modified without the content being changed. While we will try to minimize
the cases where this happen, we apologize in advance (Sorry tm Canada 🇨🇦) when it does.</p>
<h2 id="status_update">status_update</h2>
<p>This shows the latest modification date of <a href="status.json">status.json</a> file.</p>
<p>The <strong>JSON</strong> member value is a <strong>JSON</strong> quoted string obtained from the date field
of the following <code>ls(1)</code> command:</p>
<pre><code> TZ=UTC ls -D &#39;%FT%T+00:00&#39; -ld status.json</code></pre>
<p><strong>NOTE</strong>: The date and time are given with respect to <strong>UTC</strong> timezone.</p>
<p><strong>NOTE</strong>: It is possible that for some reason, the <a href="status.json">status.json</a> file
was modified without the content being changed. While we will try to minimize
the cases where this happen, we apologize in advance (Sorry tm Canada 🇨🇦) when it does.</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">
<div id="history">
Expand Down
208 changes: 206 additions & 2 deletions faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This is FAQ version **28.2.11 2025-02-27**.
- **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)
## 2. [IOCCC Judging process](#judging_proceess)
- **Q 2.0**: <a class="normal" href="#questions">What is the best way to ask a question about the IOCCC rules, guideline and tools?</a>
- **Q 2.1**: <a class="normal" href="#feedback">How can I comment or make a suggestion on IOCCC rules, guidelines and tools?</a>
- **Q 2.2**: <a class="normal" href="#warnings">Are there any compiler warnings that I should not worry about in my submissions?</a>
Expand Down Expand Up @@ -132,7 +132,7 @@ This is FAQ version **28.2.11 2025-02-27**.
- **Q 10.8**: <a class="normal" href="#menus">How do the menus on the website work and what can I do if they don't work?</a>
- **Q 10.9**: <a class="normal" href="#author-information">How do I find more information about a winning author of an entry?</a>
- **Q 10.10**: <a class="normal" href="#cb">What is this cb tool that is mentioned in the IOCCC?</a>

- **Q 10.11**: <a class="normal" href="status_json">What do the status.json JSON file indicate?</a>

## 11. [History of the IOCCC](#ioccc_history)
- **Q 11.0**: <a class="normal" href="#ioccc_start">How did the IOCCC get started?</a>
Expand Down Expand Up @@ -6875,6 +6875,210 @@ judging the IOCCC. A Unix man page for `cb`

Jump to: [top](#)


<div id="status_json">
### Q 10.11: What do the status.json JSON file indicate?
</div>

The following **JSON** members are required to be present [status.json](status.json).


<div id="no_comment">
## no_comment
</div>

This is a **mandatory** comment for which we offer no comment other
than this comment. :-)

The **JSON** member value must be the following **JSON** quoted string:

``` <!---json-->
"mandatory comment: because comments were removed from the original JSON spec"
```


<div id="IOCCC_status_version">
## IOCCC_status_version
</div>

This is the version of format of the [status.json](status.json) file.

The **JSON** member value of is a **JSON** quoted string the form "_version YYYY-MM-DD_".

This document describes version "**1.0 2024-03-09**".


<div id="contest_status">
## contest_status
</div>

This is the current status of the contest.

The following **JSON** member value string may be one of the following **JSON** quoted strings:


<div id="pending">
#### "**pending**"
</div>

While the contest **[PENDING](#pending)** the contest is not yet [open](#open), however there is a tentative scheduled
date and time by which the contest will [open](#open) for submissions.

A preliminary [IOCCC rules](next/rules.html), [IOCCC guidelines](next/guidelines.html),
and [IOCCC mkiocccentry tools](https://github.com/ioccc-src/mkiocccentry) have
been released.

You may [register for the IOCCC](next/register.html) while the contest is [pending](#pending),
however you will **NOT** receive your own Email message containing your very own
**Username and Initial Password until the contest is [open](#open)**. You will need these
to be able to [upload your submission](next/submit.html) to the [IOCCC submit
server](https://submit.ioccc.org).

Once contest moves from [pending](#pending") to [open](#open), an announcement
Email will be sent out to the mailing list of those have successfully registered for the IOCCC.
In addition, an announcement will be made to the [IOCCC news](news.html) in case you miss
that announcement Email.

While you are waiting for the contest to [open](#open), we **highly recommend**
that you review the [IOCCC rules](next/rules.html), [IOCCC guidelines](next/guidelines.html),
and [IOCCC mkiocccentry tools](https://github.com/ioccc-src/mkiocccentry).

Should you have any comments, suggestions, and concerns about the above, and **while you waiting**
for the contest to [open](#open), please see the
FAQ on "[comment or make a suggestion on IOCCC rules, guidelines and tools](#feedback)"
as well as the
FAQ on "[best way to ask a question about the IOCCC rules, guideline and tools](#questions)"
for how.

See also the
FAQ on "[how to upload your submission](next/submit.html)"
for more information on the submission process when the IOCCC [reopens](#open).


<div id="open">
#### "**open**"
</div>

While contest is **[OPEN](#open)**, those who have [registered for the IOCCC](next/register.html)
may [upload their submissions](next/submit.html) to the [IOCCC submit server](https://submit.ioccc.org).

See the
FAQ on "[how to submit](#submit)"
for more information.

See the [IOCCC news](news.html) page for details on any IOCCC related deadlines
such as when the contest will [close](#closed).

The [IOCCC rules](next/rules.html), [IOCCC guidelines](next/guidelines.html),
and [IOCCC mkiocccentry tools](https://github.com/ioccc-src/mkiocccentry)
are now official. Should you have any questions about these, please see the
FAQ on "[best way to ask a question about the IOCCC rules, guideline and tools](#questions)"
for how to ask them.

Be sure to review the official [IOCCC rules](next/rules.html), [IOCCC guidelines](next/guidelines.html),
for any changes, as well as updating your [IOCCC mkiocccentry tools](https://github.com/ioccc-src/mkiocccentry)
as changes to them may have been made while the contest was "**[pending](#pending)**".

See also the
FAQ on "[how to submit](#submit)"
for more information on the submission process when the IOCCC [reopens](#open).


<div id="judging">
#### "**judging**"
</div>

While contest is **[JUDGING](#judging)**, you cannot [register](next/register.html)
nor can you [upload submissions](next/submit.html). This is because the
[IOCCC judges](judges.html) are in the process of judging the [submissions](#how_many)
they received while the contest was [open](#open).

Watch the [@IOCCC mastodon feed](https://fosstodon.org/@ioccc) for updates.

Once the contest [closes](#closed), the judges will:

* Select the [winning entries](years.html) and announce them on the [@IOCCC
mastodon feed](https://fosstodon.org/@ioccc).

* Notify the [authors](authors.html) of entries that won the contest
via email using their registered email address.

* Announce who the [authors](authors.html) are of this year's [winning IOCCC
entries](years.html) via the [@IOCCC mastodon
feed](https://fosstodon.org/@ioccc).

* Upload the winning code to the [Official IOCCC winner
repo](https://github.com/ioccc-src/winner).

* Update the [Official IOCCC website](index.html), and in particular
display this year's [winning IOCCC entries](years.html) at the top of the [IOCCC
winning entries page](years.html).

* Update the [IOCCC news](news.html) page.


<div id="closed">
#### "**closed**"
</div>

While contest is **[CLOSED](#closed)**, you cannot [register](next/register.html)
nor can you [upload submissions](next/submit.html). You have to wait for the
next contest to [open](#open).

See the [IOCCC winning entries page](years.html) for the entries that have won
the [IOCCC](index.html).

**NOTE**: From time to time, [winning IOCCC entries](years.html) may have their write-ups updated,
`Makefiles` improved, source code fixed etc. See [IOCCC news](news.html) for details.

Watch both [this IOCCC status page](status.html) and the [@IOCCC
mastodon feed](https://fosstodon.org/@ioccc) for information about future
contest [openings](#open).


<div id="news_update">
## news_update
</div>

This shows the latest modification date for the [IOCCC news](news.html) page.

The **JSON** member value is a **JSON** quoted string obtained from the date field
of the following `ls(1)` command:

``` <!---ls-->
TZ=UTC ls -D '%FT%T+00:00' -ld news.html
```

**NOTE**: The date and time are given with respect to **UTC** timezone.

**NOTE**: It is possible that for some reason, the [IOCCC news](news.html) page
was modified without the content being changed. While we will try to minimize
the cases where this happen, we apologize in advance (Sorry tm Canada 🇨🇦) when it does.


<div id="status_update">
## status_update
</div>

This shows the latest modification date of [status.json](status.json) file.

The **JSON** member value is a **JSON** quoted string obtained from the date field
of the following `ls(1)` command:

``` <!---ls-->
TZ=UTC ls -D '%FT%T+00:00' -ld status.json
```

**NOTE**: The date and time are given with respect to **UTC** timezone.

**NOTE**: It is possible that for some reason, the [status.json](status.json) file
was modified without the content being changed. While we will try to minimize
the cases where this happen, we apologize in advance (Sorry tm Canada 🇨🇦) when it does.


Jump to: [top](#)


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

Expand Down
Loading

0 comments on commit fadb1dd

Please sign in to comment.