From 0aff81f35e468762d84b658f397563bdb51c925a Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Mon, 3 Mar 2025 13:06:43 -0800 Subject: [PATCH] improve and expand submit text, use 00.00 as a sample UUID --- faq.html | 14 +++++----- faq.md | 14 +++++----- next/submit.html | 61 ++++++++++++++++++++++++++--------------- next/submit.md | 71 ++++++++++++++++++++++++++++++++---------------- sitemap.xml | 12 ++++---- 5 files changed, 107 insertions(+), 65 deletions(-) diff --git a/faq.html b/faq.html index 48482c50c..0b2f79f44 100644 --- a/faq.html +++ b/faq.html @@ -2135,13 +2135,13 @@ However, you may wish to manually validate the tarball. The tool that does this is txzchk.

If you wish to validate the tarball without running the mkiocccentry(1) tool, for instance the tarball -submit.12345678-1234-4321-abcd-1234567890ab-2.1720636351.txz you can, after +submit.00000000-0000-4000-0000-000000000000-2.1720636351.txz you can, after installing the tools, do:

-
    txzchk submit.12345678-1234-4321-abcd-1234567890ab-2.1720636351.txz
+
    txzchk submit.00000000-0000-4000-0000-000000000000-2.1720636351.txz

Assuming that the tarball exists and is valid, you should see no output.

If you wish to see the contents, for instance like mkiocccentry(1) does, you could do:

-
    txzchk -v 1 submit.12345678-1234-4321-abcd-1234567890ab-2.1720636351.txz
+
    txzchk -v 1 submit.00000000-0000-4000-0000-000000000000-2.1720636351.txz

As the guidelines state, it is beyond the scope of this document to discuss the many tests that txzchk(1) runs; if you must know we refer you to the source @@ -2158,10 +2158,10 @@ of your submission.

Rather than mkiocccentry running this tool manually, txzchk’s algorithm uses the output of this tool. If you wish to validate your tarball filename manually, you can do so. For instance:

-
    fnamchk submit.12345678-1234-4321-abcd-1234567890ab-2.1720636351.txz
+
    fnamchk submit.00000000-0000-4000-0000-000000000000-2.1720636351.txz

Assuming everything is OK, it would show:

-

12345678-1234-4321-abcd-1234567890ab-2

+

00000000-0000-4000-0000-000000000000-2

See also the FAQ on “validating your submission tarball” @@ -2198,9 +2198,9 @@ two JSON files, .auth.json and .info.json as well as t the judges ONLY; use of this option to validate your submission puts you at a great risk of violating Rule 17!).

As an example, if your submission directory is -12345678-1234-4321-abcd-1234567890ab-0/ then you should run the following +00000000-0000-4000-0000-000000000000-3/ then you should run the following command:

-
    chkentry 12345678-1234-4321-abcd-1234567890ab-0
+
    chkentry 00000000-0000-4000-0000-000000000000-3

If there is a JSON issue detected by the jparse(3) API (i.e. it is not valid JSON) it is an error and chkentry(1) will report this, exiting with a non-zero exit code. If the parsing is OK (i.e. diff --git a/faq.md b/faq.md index 0a7d729a9..3766520ab 100644 --- a/faq.md +++ b/faq.md @@ -2003,11 +2003,11 @@ is `txzchk`. If you wish to validate the tarball without running the `mkiocccentry(1)` tool, for instance the tarball -`submit.12345678-1234-4321-abcd-1234567890ab-2.1720636351.txz` you can, after +`submit.00000000-0000-4000-0000-000000000000-2.1720636351.txz` you can, after installing the tools, do: ``` - txzchk submit.12345678-1234-4321-abcd-1234567890ab-2.1720636351.txz + txzchk submit.00000000-0000-4000-0000-000000000000-2.1720636351.txz ``` Assuming that the tarball exists and is valid, you should see no output. @@ -2016,7 +2016,7 @@ If you wish to see the contents, for instance like `mkiocccentry(1)` does, you could do: ``` - txzchk -v 1 submit.12345678-1234-4321-abcd-1234567890ab-2.1720636351.txz + txzchk -v 1 submit.00000000-0000-4000-0000-000000000000-2.1720636351.txz ``` As the [guidelines state](next/guidelines.html#txzchk), it is beyond the scope @@ -2042,12 +2042,12 @@ the output of this tool. If you wish to validate your tarball filename manually, you can do so. For instance: ``` - fnamchk submit.12345678-1234-4321-abcd-1234567890ab-2.1720636351.txz + fnamchk submit.00000000-0000-4000-0000-000000000000-2.1720636351.txz ``` Assuming everything is OK, it would show: -> `12345678-1234-4321-abcd-1234567890ab-2` +> `00000000-0000-4000-0000-000000000000-2` See also the FAQ on "[validating your submission tarball](#txzchk)" @@ -2093,12 +2093,12 @@ the judges **ONLY**; use of this option to validate your submission puts you at a great risk of violating [Rule 17](next/rules.html#rule17)!). As an example, if your submission directory is -`12345678-1234-4321-abcd-1234567890ab-0/` then you should run the following +`00000000-0000-4000-0000-000000000000-3/` then you should run the following command: ``` - chkentry 12345678-1234-4321-abcd-1234567890ab-0 + chkentry 00000000-0000-4000-0000-000000000000-3 ``` If there is a [JSON](https://www.json.org/json-en.html) issue detected by the diff --git a/next/submit.html b/next/submit.html index c69de96b6..e38f7cac8 100644 --- a/next/submit.html +++ b/next/submit.html @@ -424,7 +424,7 @@ -

How to upload your submission to the IOCCC

+

Use mkiocccentry to rebuild# How to upload your submission to the IOCCC

IMPORTANT NOTE: The IOCCC submit server is only ready for submissions ONLY WHEN THE CONTEST IS open.

@@ -462,14 +462,14 @@ select that slot.

of:

IMPORTANT: Upload only XZ compressed tarballs whose filename is:

-

submit.7ec754d4-8670-421a-a1b6-7dd3dc5f215e-SLOT.TIMESTAMP.txz

+

submit.00000000-0000-4000-0000-000000000000-SLOT.TIMESTAMP.txz

where SLOT is a slot number, and TIMESTAMP is the build time as a Unix timestamp.

We highly recommend that you use mkiocccentry(1) to create your submit file as it must pass the txzchk(1) sanity checks, and when the uncompressed tarball is untarred, the resulting directory must pass chkentry(1).

-

NOTE: the 7ec754d4-8670-421a-a1b6-7dd3dc5f215e is your UUID. MAKE SURE +

NOTE: the 00000000-0000-4000-0000-000000000000 is your UUID. MAKE SURE YOU CHANGE IT TO YOUR UUID!

NOTE: the SLOT and TIMESTAMP in the filename are generated based on your input in mkiocccentry(1).

@@ -483,11 +483,11 @@ file in the file selection pop-up in your browser.

the file selection step.

When it’s uploaded it should say something like:

-

• Uploaded file: submit.9971ada4-b6ae-427d-a7ec-e67a30362cdb-0.1740838915.txz

+

• Uploaded file: submit.00000000-0000-4000-0000-000000000000-5.1740838915.txz

And in the slot it will give you important details like:

-

Again the 7ec754d4-8670-421a-a1b6-7dd3dc5f215e is your UUID, the SLOT is the +

Again the 00000000-0000-4000-0000-000000000000 is your UUID, the SLOT is the slot number and TIMESTAMP is the build time as a Unix timestamp.

Now if you’re done, log out.

-

If, on the other hand,, you upload a file that is too big you will see something -like:

+

If, on the other hand, you upload a file that is too big you will see something like:

The file size of N exceeds the maximum size of 3999971.

@@ -511,30 +510,48 @@ like:

And if you see something like:

-

Filename for slot: 0 must match this regular expression: ^submit.dd3d30c2-d8d0-4506-adcd-d4e029147f39-0\.[1-9][0-9] {9,}\.txz$

+

Filename for slot: 5 must match this regular expression: ^submit\.00000000-0000-4000-0000-000000000000-5\.[1-9][0-9]{9,}\.txz

-

where 0 is the slot and dd3d30c2-d8d0-4506-adcd-d4e029147f39-01 is the UUID -then you MUST upload a properly named XZ compressed tarball, MAKING SURE you -package it with mkiocccentry!

-

If later on you log in and see something like:

+

You uploaded the wrong filename into a slot.

+

For example, for the user 00000000-0000-4000-0000-000000000000, slot 5, a valid filename to upload would be:

-

Status: server slot error code: 1! Use mkiocccentry to rebuild and resubmit to -this slot.

+

submit.00000000-0000-4000-0000-000000000000-5.1740838915.txz

-

or:

+

where 1740838915 is a timestamp created by the mkiocccentry(1) tool.

+

You MUST upload a properly named XZ compressed tarball, MAKING SURE you +package it with mkiocccentry!

+

If, however, the slot status shows:

+
+

Status: file successfully uploaded into slot.

+
+

Then you are successfully uploaded a file into the slot.

+

At this point you may upload another submission file into a different slot, or you’re done, log out.

+

Please note: The status page will NOT auto-refresh. After you are uploaded a file into a slot, DO NOT RELOAD +the page as this may cause your browser to needlessly reload the same file to the same slot.

+

After you fir finished uploading submissions into slots, please logout. +To see any status updates, you should logout and log back in later.

+

Checking on the status of your submission

+

You may check on the status of your submission later on, after you logout by logging back in an looking at the slot status.

+

Please note: The status page will NOT auto-refresh.

+

When the system begins to process your file (which could be an hour or two later), you might see:

+
+

Status: file fetched. The format test is pending.

+
+

After the format test is complete, if you see an error such as:

Status: submit file failed the txzchk test! Use mkiocccentry to rebuild and resubmit to this slot.

-

… or ANY OTHER ERROR then you MUST FIX your submission, repackage your +

Or:

+
+

Status: submit file failed the chkentry test! Use mkiocccentry to rebuild and resubmit to this slot.

+
+

… or ANY other error then you MUST FIX your submission, repackage your tarball with mkiocccentry and upload to the same slot again! If you do not fix this your submission WILL BE REJECTED for violating Rule 17!

-

After the submission deadline is reached, you can log in to check the status of -your submissions. This is what it will say when the judges have verified -that your tarball / submission has been validated (NOT judged), by txzchk(1) -and chkentry(1):

+

If the format test went well, then you will see:

-

Status: the format of this submission has been validated.

+

Status: submit file received by the IOCCC judges. Passed both txzchk and chkentry tests.

IMPORTANT: this does NOT mean that your submission does not violate the rules or that everything is OK once the tarball is extracted; it simply means diff --git a/next/submit.md b/next/submit.md index 26ebaefae..a33715edd 100644 --- a/next/submit.md +++ b/next/submit.md @@ -1,4 +1,4 @@ -# How to upload your submission to the IOCCC +Use mkiocccentry to rebuild# How to upload your submission to the IOCCC **IMPORTANT NOTE**: The [IOCCC submit server](https://submit.ioccc.org) is only ready for submissions @@ -49,7 +49,7 @@ of: > IMPORTANT: Upload only XZ compressed tarballs whose filename is: > -> `submit.7ec754d4-8670-421a-a1b6-7dd3dc5f215e-SLOT.TIMESTAMP.txz` +> `submit.00000000-0000-4000-0000-000000000000-SLOT.TIMESTAMP.txz` > > where `SLOT` is a slot number, and `TIMESTAMP` is the build time as a [Unix timestamp](https://unixtime.org/). @@ -58,7 +58,7 @@ timestamp](https://unixtime.org/). it must pass the `txzchk(1)` sanity checks, and when the uncompressed tarball is untarred, the resulting directory must pass `chkentry(1)`. -**NOTE**: the `7ec754d4-8670-421a-a1b6-7dd3dc5f215e` is your UUID. **MAKE SURE +**NOTE**: the `00000000-0000-4000-0000-000000000000` is your UUID. **MAKE SURE YOU CHANGE IT TO YOUR UUID**! **NOTE**: the `SLOT` and `TIMESTAMP` **in the filename** are generated based on @@ -80,12 +80,11 @@ the file selection step. When it's uploaded it should say something like: -> • Uploaded file: `submit.9971ada4-b6ae-427d-a7ec-e67a30362cdb-0.1740838915.txz` +> • Uploaded file: submit.00000000-0000-4000-0000-000000000000-5.1740838915.txz And in the slot it will give you important details like: -- the status of the submission (on upload it will say: `"uploaded file into -slot"`). +- the status of the submission - the filename, which will be in the correct format, assuming you used `mkiocccentry(1)` which is **HIGHLY** recommended so that you do not break [Rule 17](rules.html#rule17)! @@ -94,14 +93,13 @@ tarball listing). - the upload date. - the SHA256 hash of the file. -Again the `7ec754d4-8670-421a-a1b6-7dd3dc5f215e` is your UUID, the `SLOT` is the +Again the `00000000-0000-4000-0000-000000000000` is your UUID, the `SLOT` is the slot number and `TIMESTAMP` is the build time as a [Unix timestamp](https://unixtime.org/). Now if you're done, log out. -If, on the other hand,, you upload a file that is too big you will see something -like: +If, on the other hand, you upload a file that is too big you will see something like: > The file size of N exceeds the maximum size of 3999971. @@ -111,33 +109,60 @@ And if you try uploading an empty file you'll instead see: And if you see something like: -> Filename for slot: 0 must match this regular expression: `^submit.dd3d30c2-d8d0-4506-adcd-d4e029147f39-0\.[1-9][0-9] -{9,}\.txz$` +> Filename for slot: `5` must match this regular expression: `^submit\.00000000-0000-4000-0000-000000000000-5\.[1-9][0-9]{9,}\.txz` -where `0` is the slot and `dd3d30c2-d8d0-4506-adcd-d4e029147f39-01` is the UUID -then you **MUST** upload a properly named XZ compressed tarball, **MAKING SURE** you +You uploaded the wrong filename into a slot. + +For example, for the user `00000000-0000-4000-0000-000000000000`, slot `5`, a valid filename to upload would be: + +> submit.00000000-0000-4000-0000-000000000000-5.1740838915.txz + +where `1740838915` is a timestamp created by the `mkiocccentry(1)` tool. + +You **MUST** upload a properly named XZ compressed tarball, **MAKING SURE** you package it with `mkiocccentry`! -If later on you log in and see something like: +If, however, the slot status shows: -> **Status: server slot error code: 1! Use mkiocccentry to rebuild and resubmit to -this slot.** +> **Status: file successfully uploaded into slot.** -or: +Then you are successfully uploaded a file into the slot. + +At this point you may upload another submission file into a different slot, or you're done, log out. + +**Please note:** The status page will **NOT** auto-refresh. After you are uploaded a file into a slot, **DO NOT RELOAD** +the page as this may cause your browser to needlessly reload the same file to the same slot. + +After you fir finished uploading submissions into slots, please logout. +To see any status updates, you should logout and log back in later. + + +## Checking on the status of your submission + +You may check on the status of your submission later on, after you logout by logging back in an looking at the slot status. + +**Please note:** The status page will **NOT** auto-refresh. + +When the system begins to process your file (which could be an hour or two later), you might see: + +> **Status: file fetched. The format test is pending.** + +After the format test is complete, if you see an error such as: > **Status: submit file failed the txzchk test! Use mkiocccentry to rebuild and resubmit to this slot.** -... or **ANY OTHER ERROR** then you **MUST FIX** your submission, repackage your +Or: + +> **Status: submit file failed the chkentry test! Use mkiocccentry to rebuild and resubmit to this slot.** + +... or **ANY** other error then you **MUST FIX** your submission, repackage your tarball with `mkiocccentry` and upload to the same slot again! If you do not fix this your submission **WILL BE REJECTED** for violating [Rule 17](rules.html#rule17)! -After the submission deadline is reached, you can log in to check the status of -your submissions. This is what it will say when the judges have verified -that your tarball / submission has been validated (NOT judged), by `txzchk(1)` -and `chkentry(1)`: +If the format test went well, then you will see: -> **Status: the format of this submission has been validated.** +> **Status: submit file received by the IOCCC judges. Passed both txzchk and chkentry tests.** **IMPORTANT**: this does **NOT** mean that your submission does not violate the rules or that everything is OK once the tarball is extracted; it simply means diff --git a/sitemap.xml b/sitemap.xml index 7b371160c..2cc18ccc6 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -14794,7 +14794,7 @@ https://www.ioccc.org/author/John_Dalbec.json - 2025-01-10T06:06:40+00:00 + 2025-03-03T20:50:17+00:00 https://www.ioccc.org/author/John_Tromp.json @@ -15070,7 +15070,7 @@ https://www.ioccc.org/authors.html - 2025-01-30T20:14:05+00:00 + 2025-03-03T20:50:17+00:00 https://www.ioccc.org/author/Sjoerd_Mullender.json @@ -15414,11 +15414,11 @@ https://www.ioccc.org/faq.html - 2025-03-02T21:52:21+00:00 + 2025-03-03T20:50:17+00:00 https://www.ioccc.org/faq.md - 2025-03-02T21:48:49+00:00 + 2025-03-03T20:50:17+00:00 https://www.ioccc.org/inc/index.html @@ -15450,11 +15450,11 @@ https://www.ioccc.org/location.html - 2025-02-13T00:27:53+00:00 + 2025-03-03T21:02:38+00:00 https://www.ioccc.org/Makefile - 2025-03-01T21:03:38+00:00 + 2025-03-03T20:50:17+00:00 https://www.ioccc.org/news.html