From d2c6b42078ee56c2bf9b907f55555c4f5862d66a Mon Sep 17 00:00:00 2001 From: Cody Boone Ferguson <53008573+xexyl@users.noreply.github.com> Date: Thu, 6 Feb 2025 10:13:53 -0800 Subject: [PATCH] Add important note about mkiocccentry execution It is highly recommended that you run the tool from either the repo directory itself (making sure you have the most up to date version of course) or make sure you have installed it (also making sure you have the most recent version). Not doing this will cause issues with checks and in the case of out of date versions the submission would be rejected due to violating rule 17. One can specify the options to mkiocccentry for the tools required but if you forget or don't have the most up to date version you will very likely run into problems. --- faq.html | 10 ++++++++++ faq.md | 11 +++++++++++ next/guidelines.html | 12 ++++++++++++ next/guidelines.md | 13 +++++++++++++ quick-start.html | 10 ++++++++++ quick-start.md | 11 +++++++++++ 6 files changed, 67 insertions(+) diff --git a/faq.html b/faq.html index eab2d5a95..e5573faa5 100644 --- a/faq.html +++ b/faq.html @@ -697,6 +697,16 @@ directory will be created, with the name based on your IOCCC registrati username, which is in the form of a UUID, and submission number; see the rules for more details on this, and in particular Rule 17.

+

IMPORTANT NOTE: if you run the program outside the repo directory +(specifying the absolute or relative path to the tool) and you have not +installed the tools then you will have to specify the options for the tools that +are required like chkentry(1), txzchk(1) and fnamchk(1). But even if you +have installed them but some tools are out of date (in the install path) it will +cause problems. Additionally, if you do not have the most recent version when +submitting a tarball it will be rejected for not having the right versions of +the tools. This is why you MUST make sure you have the most recent version +of all the tools and you either run it from the repo directory itself OR you +install them (make install as via sudo or as root).

If the subdirectory in the work directory (based on your submit ID and slot number) already exists, you will have to move it, remove it or otherwise specify a different work directory (NOT the diff --git a/faq.md b/faq.md index a2bfa8853..ef3433712 100644 --- a/faq.md +++ b/faq.md @@ -319,6 +319,17 @@ username, which is **in the form of a UUID**, and submission number; see the [rules](next/rules.html) for more details on this, and in particular [Rule 17](next/rules.html#rule17). +**IMPORTANT NOTE**: if you run the program outside the repo directory +(specifying the absolute or relative path to the tool) and you have not +installed the tools then you will have to specify the options for the tools that +are required like `chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. But even if you +have installed them but some tools are out of date (in the install path) it will +cause problems. Additionally, if you do not have the most recent version when +submitting a tarball it will be rejected for not having the right versions of +the tools. This is why you **MUST** make sure you have the most recent version +of all the tools and you either run it from the repo directory itself OR you +install them (`make install` as via `sudo` or as root). + If the **_subdirectory_ in the _work directory_** (based on your submit ID and slot number) already exists, you will have to move it, remove it or otherwise specify a different work directory (**NOT** the diff --git a/next/guidelines.html b/next/guidelines.html index c6b6e90cb..cefbde128 100644 --- a/next/guidelines.html +++ b/next/guidelines.html @@ -609,6 +609,18 @@ 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.

+IMPORTANT NOTE: if you run the program outside the repo directory +(specifying the absolute or relative path to the tool) and you have not +installed the tools then you will have to specify the options for the tools that +are required like chkentry(1), txzchk(1) and fnamchk(1). But even if you +have installed them but some tools are out of date (in the install path) it will +cause problems. Additionally, if you do not have the most recent version when +submitting a tarball it will be rejected for not having the right versions of +the tools. This is why you MUST make sure you have the most recent +version of all the tools and you either run it from the repo directory itself OR +you install them (make install as via sudo or as root). +

+

Rule 17 has been significantly modified to account for the new mkiocccentry repo tools. Thus, you are STRONGLY advised to use the mkiocccentry(1) tool diff --git a/next/guidelines.md b/next/guidelines.md index 27d78b377..709074189 100644 --- a/next/guidelines.md +++ b/next/guidelines.md @@ -233,6 +233,19 @@ 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.

+

+**IMPORTANT NOTE**: if you run the program outside the repo directory +(specifying the absolute or relative path to the tool) and you have not +installed the tools then you will have to specify the options for the tools that +are required like `chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. But even if you +have installed them but some tools are out of date (in the install path) it will +cause problems. Additionally, if you do not have the most recent version when +submitting a tarball it will be rejected for not having the right versions of +the tools. This is why you **MUST** make sure you have the most recent +version of all the tools and you either run it from the repo directory itself OR +you install them (`make install` as via `sudo` or as root). +

+

[Rule 17](rules.html#rule17) has been **significantly modified** to account for the new [mkiocccentry repo](https://github.com/ioccc-src/mkiocccentry) tools. diff --git a/quick-start.html b/quick-start.html index 2b73ff130..ff688bd6f 100644 --- a/quick-start.html +++ b/quick-start.html @@ -540,6 +540,16 @@ However, installing it will make it easier for you as you can run it from your submission’s directory. See the FAQ on “installing mkiocccentry” at the mkiocccentry repo.

+

However, an IMPORTANT NOTE: if you run the program outside the repo +directory (specifying the absolute or relative path to the tool) and you +have not installed the tools then you will have to specify the options for the +tools that are required like chkentry(1), txzchk(1) and fnamchk(1). But +even if you have installed them but some tools are out of date (in the install +path) it will cause problems. Additionally, if you do not have the most recent +version when submitting a tarball it will be rejected for not having the right +versions of the tools. This is why you MUST make sure you have the most +recent version of all the tools and you either run it from the repo directory +itself OR you install them (make install as via sudo or as root).

If the mkiocccentry tool indicates that there is a problem with your submission, especially if it identifies a Rule 2, or any other rule, related problem, you are strongly encouraged to revise and diff --git a/quick-start.md b/quick-start.md index 7e3662627..0ba5b7f3e 100644 --- a/quick-start.md +++ b/quick-start.md @@ -164,6 +164,17 @@ submission's directory. See the FAQ on "**[installing mkiocccentry](https://github.com/ioccc-src/mkiocccentry/blob/master/FAQ.md#install)**" at the mkiocccentry repo. +However, an **IMPORTANT NOTE**: if you run the program outside the repo +directory (specifying the absolute or relative path to the tool) and you +have not installed the tools then you will have to specify the options for the +tools that are required like `chkentry(1)`, `txzchk(1)` and `fnamchk(1)`. But +even if you have installed them but some tools are out of date (in the install +path) it will cause problems. Additionally, if you do not have the most recent +version when submitting a tarball it will be rejected for not having the right +versions of the tools. This is why you **MUST** make sure you have the most +recent version of all the tools and you either run it from the repo directory +itself OR you install them (`make install` as via `sudo` or as root). + If the `mkiocccentry` tool indicates that there is a problem with your submission, especially if it identifies a [Rule 2](next/rules.html#rule2), or any other rule, related problem, you are **strongly** encouraged to revise and