From 362602745549cb2fb26c40d6ab664c4912d11660 Mon Sep 17 00:00:00 2001
From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com>
Date: Thu, 16 Jan 2025 11:32:32 -0800
Subject: [PATCH] Add details about -s seed/-d to FAQ and guidelines
---
faq.html | 28 +++++++++++++++++++++++++++-
faq.md | 38 +++++++++++++++++++++++++++++++++++++-
next/guidelines.html | 23 +++++++++++++++++++++--
next/guidelines.md | 31 +++++++++++++++++++++++++++++--
4 files changed, 114 insertions(+), 6 deletions(-)
diff --git a/faq.html b/faq.html
index 240f52e7f..60f4dac4a 100644
--- a/faq.html
+++ b/faq.html
@@ -425,7 +425,7 @@
IOCCC FAQ Table of Contents
-This is FAQ version 28.2.0 2024-12-28.
+This is FAQ version 28.2.0 2025-01-16.
@@ -965,6 +966,31 @@ as MAX_TARBALL_LEN and your total number of files in your xz compre
tarball does not exceed the limit, defined as MAX_FILE_COUNT in
limit_ioccc.h,
you can include tarballs with subdirectories or other files.
+
+
Q 1.5: How can I test my submission passes tests without having to answer questions?
+
+In case you do not have a UUID or you simply want to test if mkiocccentry(1)
+does not detect any issues with your submission, without having to answer all
+the questions, you can use the -d option (which is an alias for -s 21701
+where 21701 is the seed) to have the tool make up pseudo-randomly selected
+answers.
+Please note that the tool will NOT delete the directory it makes so if you
+do have to try again you’ll have to remove it.
+An example use of this option is:
+
mkiocccentry -d test_work prog.c Makefile remarks.md
+This will run the tests that mkiocccentry(1), write the JSON files, use
+chkentry(1), package the tarball and run txzchk(1) on it.
+See also the
+FAQ on “.info.json”,
+the
+FAQ on “.auth.json”,
+the
+FAQ on “chkentry,
+the
+FAQ on”txzchk”
+and the
+FAQ on “fnamchk”
+for more details.
diff --git a/faq.md b/faq.md
index 419fb0eca..86aab2780 100644
--- a/faq.md
+++ b/faq.md
@@ -1,6 +1,6 @@
# IOCCC FAQ Table of Contents
-This is FAQ version **28.2.0 2024-12-28**.
+This is FAQ version **28.2.0 2025-01-16**.
## 0. [Entering the IOCCC: the bare minimum you need to know](#enter_questions)
@@ -22,6 +22,7 @@ This is FAQ version **28.2.0 2024-12-28**.
- **Q 1.2**:
What is markdown and how does the IOCCC use it?
- **Q 1.3**:
How do I report bugs in an `mkiocccentry` tool?
- **Q 1.4**:
How may I use subdirectories in my submission if Rule 17 disallows them?
+- **Q 1.5**:
How can I test my submission passes tests without having to answer questions?
## 2. [IOCCC Judging process](#judging)
@@ -647,6 +648,7 @@ for more thorough details on bug reporting.
Jump to: [top](#)
+
#### Q 1.4: How may I use subdirectories in my submission if Rule 17 disallows them?
@@ -659,6 +661,40 @@ tarball does not exceed the limit, defined as `MAX_FILE_COUNT` in
[limit_ioccc.h](https://github.com/ioccc-src/mkiocccentry/blob/master/soup/limit_ioccc.h),
you can include tarballs with subdirectories or other files.
+
+#### Q 1.5: How can I test my submission passes tests without having to answer questions?
+
+
+In case you do not have a UUID or you simply want to test if `mkiocccentry(1)`
+does not detect any issues with your submission, without having to answer all
+the questions, you can use the `-d` option (which is an alias for `-s 21701`
+where `21701` is the seed) to have the tool make up pseudo-randomly selected
+answers.
+
+Please note that the tool will **NOT** delete the directory it makes so if you
+do have to try again you'll have to remove it.
+
+An example use of this option is:
+
+```
+ mkiocccentry -d test_work prog.c Makefile remarks.md
+```
+
+This will run the tests that `mkiocccentry(1)`, write the JSON files, use
+`chkentry(1)`, package the tarball and run `txzchk(1)` on it.
+
+See also the
+FAQ on "[.info.json](#info_json)",
+the
+FAQ on "[.auth.json](#auth_json)",
+the
+FAQ on "[chkentry](#chkentry),
+the
+FAQ on "[txzchk](#txzchk)"
+and the
+FAQ on "[fnamchk](#fnamchk)"
+for more details.
+
diff --git a/next/guidelines.html b/next/guidelines.html
index 7e98c2d0a..95b3b6759 100644
--- a/next/guidelines.html
+++ b/next/guidelines.html
@@ -461,7 +461,7 @@ writing by
contacting the judges.
-These IOCCC guidelines are version 28.30 2024-12-28.
+These IOCCC guidelines are version 28.30 2025-01-16.
The markdown form of these guidelines
@@ -590,6 +590,13 @@ uploaded submission by rebuilding your submission with the mkiocccentry(1)
and then re-uploading it to the same slot no the submit server.
+To help you with this, so that you do not have to repeatedly answer all the
+questions, the mkiocccentry(1) tool has the options -a answers, -A answers
+and -i answers, where -a will write to an answers file if it does not
+already exist, -A will overwrite the file and -i will read the answers from
+the file.
+
+
Once the contest enters the judging state, you will
NOT be allowed to upload your submission files.
@@ -622,6 +629,18 @@ To assist in the formation of the xz compressed tarball for submission, use the
to account for the new mkiocccentry repo tools.
+If you wish to test that your submission passes the mkiocccentry(1) tests
+without having to put in answers each time, you can use the -d or -s seed
+option to mkiocccentry for the tool to pseudo-randomly create answers for you.
+The -d option is an alias for -s 21701. An example use:
+
+ mkiocccentry -d test_work prog.c Makefile remarks.md
+
+where test_work is the directory which the tarball will be formed. Be aware
+that if the directory exists already, you will have to remove it or move it
+before this option will work a second time, just like in normal mode.
+
+
See the
FAQ on “obtaining and compiling the mkiocccentry tools”
and the
@@ -679,7 +698,7 @@ guidelines, we will attempt to use a very small plug, if not
smaller. Or, maybe not. :-)
-There may be less than 2^7+1 reasons why these IOCCC
+There may be fewer than 2^7+1 reasons why these IOCCC
guidelines seem obfuscated.
Check out your program and be sure that it works. We sometimes make
diff --git a/next/guidelines.md b/next/guidelines.md
index d4fece57d..e0bee98c7 100644
--- a/next/guidelines.md
+++ b/next/guidelines.md
@@ -49,7 +49,7 @@ Jump to: [top](#)
-These [IOCCC guidelines](guidelines.html) are version **28.30 2024-12-28**.
+These [IOCCC guidelines](guidelines.html) are version **28.30 2025-01-16**.
@@ -208,6 +208,14 @@ uploaded submission by rebuilding your submission with the `mkiocccentry(1)` too
and then re-uploading it to the same slot no the [submit server](https://submit.ioccc.org).
+
+To help you with this, so that you do not have to repeatedly answer all the
+questions, the `mkiocccentry(1)` tool has the options `-a answers`, `-A answers`
+and `-i answers`, where `-a` will write to an answers file if it does not
+already exist, `-A` will overwrite the file and `-i` will read the answers from
+the file.
+
+
Once the contest enters the **[judging](../status.html#judging)** state, you will
**NOT** be allowed to upload your submission files.
@@ -248,6 +256,23 @@ To assist in the formation of the xz compressed tarball for submission, use the
to account for the new [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry) tools.
+
+If you wish to test that your submission passes the `mkiocccentry(1)` tests
+without having to put in answers each time, you can use the `-d` or `-s seed`
+option to `mkiocccentry` for the tool to pseudo-randomly create answers for you.
+The `-d` option is an alias for `-s 21701`. An example use:
+
+
+```
+ mkiocccentry -d test_work prog.c Makefile remarks.md
+```
+
+
+where `test_work` is the directory which the tarball will be formed. Be aware
+that if the directory exists already, you will have to remove it or move it
+before this option will work a second time, just like in normal mode.
+
+
See the
FAQ on "[obtaining and compiling the mkiocccentry tools](../faq.html#mkiocccentry)"
@@ -259,6 +284,8 @@ as well as
[how to upload your submission](submit.html) for the IOCCC.
+
+
Jump to: [top](#)
@@ -317,7 +344,7 @@ smaller. Or, maybe not. :-)
-There may be less than 2^7+1 reasons why these [IOCCC
+There may be fewer than 2^7+1 reasons why these [IOCCC
guidelines](guidelines.html) seem obfuscated.