+name (double quoted string)
+
+- The name of this author.
+
location_code (double quoted string)
+
+NOTE: in mkiocccentry use XX if you want your location to be anonymous.
email (null or double quoted string)
+
+- The email of this author in the form of
x@y, or null if not provided.
+
url (null or double quoted string)
+
+- The primary URL of this author, or
null if not provided.
+
alt_url (null or double quoted string)
+
+- The alt URL of this author, or
null if not provided.
+
mastodon (null or double quoted string)
+
+- The Mastodon handle of this author in the form of
@user@domain, or
+null if not provided.
+
github (null or double quoted string)
+
+- The GitHub account of this author in the form of
@user, or null if not
+provided.
+
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
+the range of 1 THROUGH MAX_AFFILIATION_LEN (see
+soup/limit_ioccc.h
+in the mkiocccentry repo). If
+this is not the case you stand a great risk of having your submission
+rejected for violating Rule 17!
+NOTE: an affiliation does NOT have any affect on whether you will win or not.
past_winning_author (boolean)
+
+true if this author claims to have won a past IOCCC, false if this
+author has NOT won before.
+NOTE: this has NO effect on whether you will win or not.
default_handle (boolean)
+
+true if this default handle was accepted, false if one is provided
+by this author.
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
+your previous winning entries, to help in organising the
+authors.html page and the author JSON file (see: What is an
+author handle? and What is an author_handle.json
+file and how are they used?).
author_number (number)
+
+- This author number in the
authors array.
+
+
+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
+AUTH_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
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
+IOCCC_CONTEST in
+soup/limit_ioccc.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
IOCCC_year (number)
+
+- The year this contest was run in.
+
+NOTE: sometimes an IOCCC year runs into another year and the contest year
+might not match when it ends.
+NOTE: this MUST match THIS IOCCC’s contest, defined as
+IOCCC_YEAR in
+soup/limit_ioccc.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
mkiocccentry_version (double quoted string)
+
+- The version of
mkiocccentry that formed this .auth.json file.
+
+NOTE: this MUST match THIS IOCCC’s mkiocccentry version,
+defined as MKIOCCCENTRY_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
chkentry_version (double quoted string)
+
+- The version of
chkentry that was used to validate this .auth.json,
+assuming that it was created by mkiocccentry.
+
+NOTE: this MUST match THIS IOCCC’s chkentry version, defined
+as CHKENTRY_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
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 (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 for more details
+on this, and in particular Rule 17.
+
+NOTE: if the contest ID is NOT in this format then fnamchk will
+report it as an error and your submission WILL BE rejected for
+violating Rule 17!
tarball (double quoted string)
+
+- The xz compressed tarball filename.
+
+NOTE: this MUST match the actual tarball’s filename in order for
+this to be valid. If there is a mismatch you stand a great risk of having
+your submission rejected for violating Rule 17!
+Moreover, it is possible that txzchk will report a problem through
+fnamchk(1) which also puts you at great risk of violating Rule
+17. If txzchk does not detect this, though, it
+does not mean it’s a bug but rather that the directory in the tarball
+matches the filename.
submit_slot (number)
+
+- The submission number.
+
+NOTE: this MUST be within the range of 0 THROUGH
+MAX_SUBMIT_SLOT (see
+soup/limit_ioccc.h
+in the mkiocccentry repo). If
+this is not the case you stand a great risk of having your submission
+rejected for violating Rule 17!
author_count (number)
+
+- How many authors this submission has.
+
+NOTE: this MUST be within the range of 1 THROUGH
+MAX_AUTHORS (see
+soup/limit_ioccc.h
+in the mkiocccentry repo). If
+this is not the case you stand a great risk of having your submission
+rejected for violating the Rules! Moreover, if the
+author_count is inconsitent with how many authors are in the authors
+array your submission will be invalid.
test_mode (boolean)
+
+true if the test ID was used to form the tarball, else false.
+NOTE: if true then this may NOT be submitted to the contest! Please do
+NOT email the Judges your submission!
formed_timestamp (number)
+
+- Seconds since epoch when
.auth.json/.info json was formed (see gettimeofday(2)).
+
+NOTE: this MUST be greater than or equal to MIN_TIMESTAMP (see
+soup/limit_ioccc.h
+in the mkiocccentry repo). If
+this is not the case your submission WILL BE rejected.
formed_timestamp_usec (number)
+
+- Microseconds since the tstamp (seconds since epoch when
.auth.json was
+formed - see gettimeofday(2)) second.
+
+NOTE: this MUST be within the range MIN_FORMED_TIMESTAMP_USEC
+THROUGH MAX_FORMED_TIMESTAMP_USEC and is validated by
+test_formed_timestamp_usec() in
+soup/entry_util.c
+in the mkiocccentry repo. If
+this is not the case chkentry(1) will report an error and your
+submission WILL BE rejected!
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 #defined
+as TIMESTAMP_EPOCH in
+soup/limit_ioccc.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
min_timestamp (number)
+
+- Minimum number of second since epoch for this IOCCC.
+
+NOTE: this MUST be >= MIN_TIMESTAMP defined in
+soup/limit_ioccc.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
+
+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
+INFO_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
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
+IOCCC_CONTEST in
+soup/limit_ioccc.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
IOCCC_year (number)
+
+- The year this contest was run in.
+
+NOTE: sometimes an IOCCC year runs into another year and the contest year
+might not match when it ends.
+NOTE: this MUST match THIS IOCCC’s contest, defined as
+IOCCC_YEAR in
+soup/limit_ioccc.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
mkiocccentry_version (double quoted string)
+
+- The version of
mkiocccentry that formed this .auth.json file.
+
+NOTE: this MUST match THIS IOCCC’s mkiocccentry version,
+defined as MKIOCCCENTRY_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
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,
+defined as IOCCCSIZE_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
chkentry_version (double quoted string)
+
+- The version of
chkentry that was used to validate this .info.json,
+assuming that it was created by mkiocccentry.
+
+NOTE: this MUST match THIS IOCCC’s chkentry version, defined
+as CHKENTRY_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
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, defined
+as FNAMCHK_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
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
+as TXZCHK_VERSION in
+soup/version.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
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 for more details
+on this, and in particular Rule 17.
+
+NOTE: if the contest ID is NOT in this format then fnamchk will
+report it as an error and your submission WILL BE rejected for
+violating Rule 17!
submit_slot (number)
+
+- The submission number.
+
+NOTE: this MUST be within the range of 0 THROUGH
+MAX_SUBMIT_SLOT (see
+soup/limit_ioccc.h
+in the mkiocccentry repo). If
+this is not the case you stand a great risk of having your submission
+rejected for violating Rule 17!
title (double quoted string)
+
+NOTE: if this is NOT the case you stand a great risk of having your submission
+rejected for violating Rule 17!
abstract (double quoted string)
+
+NOTE: if your abstract is 0 in length or > the maximum abstract length you
+stand a great risk of having your submission rejected for violating Rule
+17!
tarball (double quoted string)
+
+- The xz compressed tarball filename.
+
+NOTE: this MUST match the actual tarball’s filename in order for
+this to be valid. If there is a mismatch you stand a great risk of having
+your submission rejected for violating Rule 17!
+Moreover, it is possible that txzchk will report a problem through
+fnamchk(1) which also puts you at great risk of violating Rule
+17. If txzchk does not detect this, though, it
+does not mean it’s a bug but rather that the directory in the tarball
+matches the filename.
rule_2a_size (number)
+
+NOTE: if this violates Rule 2a you stand a great
+chance of having your submission rejected for violating the
+Rules!
rule_2b_size (number)
+
+NOTE: if this violates Rule 2b you stand a great
+chance of having your submission rejected for violating the
+Rules!
empty_override (boolean)
+
+true if user override warning of an empty source file, else false.
rule_2a_override (boolean)
+
+true if user overrides warning of Rule 2a
+violation, else false.
+NOTE: if the Rule 2a calculated size is NOT
+violated but this is true then you stand a good chance of having your
+submission rejected for violating Rule 17!
rule_2a_mismatch (boolean)
+
+true if Rule 2a calculated size is not the
+same as the file size.
rule_2b_override (boolean)
+
+true if user overrides warning of Rule 2b
+violation, else false.
+NOTE: if the Rule 2b calculated size is NOT
+violated but this is true then you stand a good chance of having your
+submission rejected for violating Rule 17!
highbit_warning (boolean)
+
+true if iocccsize detects a high bit (unescaped octets with the high
+bit set - octet value >= 128); see Rule 13, else
+false.
nul_warning (boolean)
+
+true if iocccsize detects a NUL character in the prog.c, else
+false.
trigraph_warning (boolean)
+
+true if iocccsize detects an unknown or invalid trigraph in
+prog.c, else false.
wordbuf_warning (boolean)
+
+true if prog.c triggered a word buffer overflow (see iocccsize),
+else false.
+NOTE: this does NOT mean that your code has been checked for buffer
+overflows in general.
ungetc_warning (boolean)
+
+true if prog.c triggered an ungetc(3) error, else false.
Makefile_override (boolean)
+
+true if the user overrides any warnings about an incomplete/incorrect
+Makefile, else false.
+NOTE: if the Makefile has no problems and this is true then
+you stand a good chance of having your submission rejected for violating
+Rule 17!
first_rule_is_all (boolean)
+
+true if the first rule in the Makefile is
+all, else false.
found_all_rule (boolean)
+
+true if the Makefile has an all rule, else
+false.
found_clean_rule (boolean)
+
+true if the Makefile has a clean rule, else
+false.
found_clobber_rule (boolean)
+
+true if the Makefile has a clobber rule,
+else false.
found_try_rule (boolean)
+
+true if the Makefile has a try rule, else
+false.
test_mode (boolean)
+
+true if the test ID was used to form the tarball, else false.
+NOTE: if this is true then this may NOT be submitted to the
+contest! Please do NOT email the Judges your submission!
formed_timestamp (number)
+
+- Seconds since epoch when .auth.json/
.info json was formed (see gettimeofday(2)).
+
+NOTE: this MUST be greater than or equal to MIN_TIMESTAMP (see
+soup/limit_ioccc.h
+in the mkiocccentry repo). If
+this is not the case your submission WILL BE rejected.
formed_timestamp_usec (number)
+
+- Microseconds since the tstamp (seconds since epoch when
.auth.json was
+formed - see gettimeofday(2)) second.
+
+NOTE: this MUST be within the range MIN_FORMED_TIMESTAMP_USEC
+THROUGH MAX_FORMED_TIMESTAMP_USEC and is validated by
+test_formed_timestamp_usec() in
+soup/entry_util.c
+in the mkiocccentry repo. If
+this is not the case chkentry(1) will report an error and your
+submission WILL BE rejected!
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 #defined
+as TIMESTAMP_EPOCH in
+soup/limit_ioccc.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
min_timestamp (number)
+
+- Minimum number of second since epoch for this IOCCC.
+
+NOTE: this MUST be >= MIN_TIMESTAMP defined in
+soup/limit_ioccc.h
+in the mkiocccentry repo. If
+this is not the case your submission WILL BE rejected!
+By tradition, we do not say.
-
FAQ 6.6: What is an author_handle.json file and how are they used?
+FAQ 6.6: What is an author_handle.json file and how are they used?
TL:DR: The contents of these JSON files contain the best known
@@ -2753,7 +3401,7 @@ of the form:
author/author_handle.json
where author_handle is an author handle. See FAQ 6.5 for more
information about an author handles.
-author_handle.json JSON file contents
+author_handle.json JSON file contents
The syntax of a author_handle.json follows the So-called JSON spec.
See json_index.html
for information on the So-called JSON spec.
@@ -2990,7 +3638,7 @@ unknown, it should be the JSON null as the JSON value of this
For example:
"mastodon_url" : null,
NOTE: The JSON null is NOT enclosed in quotes!
-See “FAQ 6.12: What is Mastodon and why does IOCCC use it?” for more
+
See the FAQ on what is Mastodon and why does IOCCC uses it for more
information on Mastodon.
github
"github" : "@mame",
@@ -3316,8 +3964,10 @@ to help ensure that everyone may enjoy the IOCCC.
The IOCCC uses Mastodon for news updates,
announcements, and for various other social media purposes.
Please follow the IOCCC on Mastodon.
- The IOCCC no longer uses twitter, or whatever that someone who appears to have poor impulse control
- (allegedly) calls their platform these days.
+
+The IOCCC no longer uses twitter, or whatever that someone who appears to have
+poor impulse control (allegedly) calls their platform these days.
+
The IOCCC prefers to reside in the fediverse.
For help with Mastodon:
There is help with Mastodon available for
diff --git a/faq.md b/faq.md
index f243b6106..dcf91f4d2 100644
--- a/faq.md
+++ b/faq.md
@@ -13,7 +13,8 @@ This is FAQ version **28.0 2024-07-14**.
- 0.6 - What is the best way to ask a question about the IOCCC rules, guideline and tools?
- 0.7 - What are the IOCCC best practices for using markdown?
- 0.8 - How do I report bugs in a `mkiocccentry` tool?
-
+- 0.9 - What is a `.auth.json` file?
+- 0.10 - What is a `.info.json` file?
## Section 1 - [History of the IOCCC](#faq1)
@@ -25,7 +26,7 @@ This is FAQ version **28.0 2024-07-14**.
## Section 2 - [IOCCC Judging process](#faq2)
- 2.0 - How many entries do the judges receive for a given IOCCC?
-- 2.1 - What should I put in the remarks.md file of my entry?
+- 2.1 - What should I put in the remarks.md file of my submission?
- 2.2 - Why don't you publish entries that do not win?
- 2.3 - How much time does it take to judge the contest?
- 2.4 - How many judging rounds do you have?
@@ -90,7 +91,7 @@ other inconsistencies with the original entry?](#faq4_3)
- 6.3 - May I use parts of the IOCCC in an article, book, newsletter, or instructional material?
- 6.4 - Why do you sometimes use the first person plural?
- 6.5 - What is an `author handle`?
-- 6.6 - What is an author_handle.json file and how are they used?
+- 6.6 - What is an `author_handle.json` file and how are they used?
- 6.7 - What is an `entry_id`?
- 6.8 - What is the purpose of the .top, .year and .path files?
- 6.9 - What is the current meaning of the IOCCC terms Author, Entry, and Submission?
@@ -365,10 +366,12 @@ of the same theme.
+
### FAQ 0.2: What should I put in my entry's Makefile?
+
-### FAQ 0.8: - How do I report bugs in a `mkiocccentry` tool?
+### FAQ 0.8: How do I report bugs in a `mkiocccentry` tool?
@@ -581,6 +583,645 @@ If it does find problems, it will give you a summary of the problems and when
you attach the log file we will see those too.
+
+
+### FAQ 0.9: What is a `.auth.json` file?
+
+
+
+### FAQ 0.10: What is a `.info.json` file?
+
+
## Section 1: History of the IOCCC
@@ -954,7 +1595,9 @@ By tradition, we do not say.
@@ -3387,7 +4030,7 @@ Anonymous `author_handle`'s match this regexp:
-### FAQ 6.6: What is an author_handle.json file and how are they used?
+### FAQ 6.6: What is an `author_handle.json` file and how are they used?
@@ -3416,7 +4059,7 @@ of the form:
where _author_handle_ is an author handle. See [FAQ 6.5](#author_handle_faq) for more
information about an author handles.
-#### author_handle.json JSON file contents
+#### `author_handle.json` JSON file contents
The syntax of a `author_handle.json` follows the _So-called JSON spec_.
See [json_index.html](https://github.com/ioccc-src/mkiocccentry/blob/master/jparse/json_index.html#so_called_json_spec)
@@ -3827,7 +4470,7 @@ For example:
NOTE: The _JSON null_ is **NOT** enclosed in quotes!
-See "[FAQ 6.12: What is Mastodon and why does IOCCC use it?](faq.html#try_mastodon)" for more
+See [the FAQ on what is Mastodon and why does IOCCC uses it](faq.html#try_mastodon) for more
information on Mastodon.
@@ -4330,10 +4973,8 @@ announcements, and for various other social media purposes.
**Please follow the [IOCCC on Mastodon](https://fosstodon.org/@ioccc)**.
-```
- The IOCCC no longer uses twitter, or whatever that someone who appears to have poor impulse control
- (allegedly) calls their platform these days.
-```
+> The IOCCC no longer uses twitter, or whatever that someone who appears to have
+poor impulse control (allegedly) calls their platform these days.
The IOCCC prefers to reside in the [fediverse](https://fediverse.info).