diff --git a/bin/README.md b/bin/README.md index 789d7c326..9ce771b4c 100644 --- a/bin/README.md +++ b/bin/README.md @@ -75,23 +75,6 @@ be directly invoked as well, should you wish to see their output or if you have some odd need to do so. -
-### [add-dir.sh](%%REPO_URL%%/bin/add-dir.sh) -
- -This tool is used by the [Judges](../judges.html) as part of the final -steps to announce a new winning IOCCC entry. - -Usage: - -``` - mkdir -p YYYY/dir - bin/add-dir.sh YYYY/dir -``` - -Here, `YYYY/dir` must be the path to the winning IOCCC entry. - -
### [all-run.sh](%%REPO_URL%%/bin/all-run.sh)
@@ -234,12 +217,7 @@ This tool is used by the [Judges](../judges.html) as part of the final steps to announce a new set of winning IOCCC entries. Given a submission (that has won the IOCCC and thus will become an entry), with a `.auth.json` -and `.info.json` and **NO** `.entry.json` file (since it just won), we convert the -`.auth.json` and `.info.json` into a new `.entry.json` file. - -This tool will, given a submission that has won the IOCCC (and thus will become a published entry), with -a `.auth.json` and `.info.json` and NO `.entry.json` file (since it's new), we -convert the `.auth.json` and `.info.json` into a new `.entry.json` file. +and `.info.json`, we convert the `.auth.json` and `.info.json` into a new `.entry.json` file. **NOTE**: the `.auth.json` and `.info.json` files are formed by the `mkiocccentry(1)` tool from the [mkiocccentry GitHub @@ -260,8 +238,49 @@ Usage: bin/cvt-submission.sh -v 1 YYYY/dir ``` -Here, `YYYY/dir` is the path of the submission under the `YYYY` -year directory. For instance +Here, `YYYY/dir` is the path of the submission under the `YYYY` year directory. + +This tool will form a compressed tarball of any files under `YYYY/dir` +that could be modified or removed by this tool (unless `-N` is used in which +case this tool does nothing). The compressed tarball, formed by default +under the `/var/tmp` directory, may contain such as: + +- YYYY/dir/.info.json +- YYYY/dir/.auth.json +- YYYY/dir/remarks.md +- YYYY/dir/README.md +- YYYY/dir/index.md +- YYYY/dir/YYYY_dir.tar.bz2 +- author/author_handle.json (could be more than one file) + +Only those files that exist will be put into the compressed tarball. +The compressed tarball formed (by default under the `/var/tmp` directory) +is of the following form: + +> YYYY_dir.YYYYMMDD.hhmmss.tar.bz2 + +The purpose of this compressed tarball is to allow the files in the +submission directory (that could be modified or removed by this tool) +to be restored as follows: + +```sh +tar -jxvf /var/tmp/YYYY_dir.YYYYMMDD.hhmmss.tar.bz2 YYYY/dir +``` + +One may also restore modified `author/author_handle.json` files using: + +```sh +tar -jxvf /var/tmp/YYYY_dir.YYYYMMDD.hhmmss.tar.bz2 author +``` + +**NOTE**: This interactive tool (unless `-i input_data` is used) does +**NOT** perform all of the steps needed to make a directory a new winning +IOCCC entry. For example, files such as `README.md` and/or `index.html` +might contain "**XXX**" patterns indicating where the [Judges](../judges.html) +need to add content. Moreover, the `Makefile` and `.gitignore` files +need to be examined for suitability, etc. + +**HINT**: Executing this tool on your submission will **NOT** make you an IOCCC winner. :-)
@@ -665,6 +684,32 @@ This tool is used in the [bin/md2html.cfg](%%REPO_URL%%/bin/md2html.cfg) file as the [md2html tool](index.html#md2html). +
+### [new-dir.sh](%%REPO_URL%%/bin/new-dir.sh) +
+ +This tool is used by the [Judges](../judges.html) as one of the +steps needed to announce a new winning IOCCC entry. + +Usage: + +``` + mkdir -p YYYY/dir + bin/new-dir.sh YYYY/dir +``` + +Here, `YYYY/dir` must be the path to the winning IOCCC entry. + +**NOTE**: This tool does **NOT** perform all of the steps needed +to make a directory a new winning IOCCC entry. It only starts the +framework for doing so, creating a situation where the +[cvt-submission](#cvt-submission) tool be be run. + +This tool can modify the top level `.allyear` file, and `YYYY/Makefile` files. + +**HINT**: Executing this tool on your submission will **NOT** make you an IOCCC winner. :-) + +
### [new-year.sh](%%REPO_URL%%/bin/new-year.sh)
diff --git a/bin/index.html b/bin/index.html index 639a5b3f3..5b91a4c52 100644 --- a/bin/index.html +++ b/bin/index.html @@ -433,15 +433,6 @@ that you use the -h option on it first.

bin/md2html.cfg file but some of these tools can be directly invoked as well, should you wish to see their output or if you have some odd need to do so.

-
-

add-dir.sh

-
-

This tool is used by the Judges as part of the final -steps to announce a new winning IOCCC entry.

-

Usage:

-
    mkdir -p YYYY/dir
-    bin/add-dir.sh YYYY/dir
-

Here, YYYY/dir must be the path to the winning IOCCC entry.

all-run.sh

@@ -531,11 +522,7 @@ content).

This tool is used by the Judges as part of the final steps to announce a new set of winning IOCCC entries.

Given a submission (that has won the IOCCC and thus will become an entry), with a .auth.json -and .info.json and NO .entry.json file (since it just won), we convert the -.auth.json and .info.json into a new .entry.json file.

-

This tool will, given a submission that has won the IOCCC (and thus will become a published entry), with -a .auth.json and .info.json and NO .entry.json file (since it’s new), we -convert the .auth.json and .info.json into a new .entry.json file.

+and .info.json, we convert the .auth.json and .info.json into a new .entry.json file.

NOTE: the .auth.json and .info.json files are formed by the mkiocccentry(1) tool from the mkiocccentry GitHub repo as part of packaging @@ -549,8 +536,39 @@ See also the FAQ on “.entry.json”.

Usage:

    bin/cvt-submission.sh -v 1 YYYY/dir
-

Here, YYYY/dir is the path of the submission under the YYYY -year directory. For instance

+

Here, YYYY/dir is the path of the submission under the YYYY year directory.

+

This tool will form a compressed tarball of any files under YYYY/dir +that could be modified or removed by this tool (unless -N is used in which +case this tool does nothing). The compressed tarball, formed by default +under the /var/tmp directory, may contain such as:

+ +

Only those files that exist will be put into the compressed tarball. +The compressed tarball formed (by default under the /var/tmp directory) +is of the following form:

+
+

YYYY_dir.YYYYMMDD.hhmmss.tar.bz2

+
+

The purpose of this compressed tarball is to allow the files in the +submission directory (that could be modified or removed by this tool) +to be restored as follows:

+
tar -jxvf /var/tmp/YYYY_dir.YYYYMMDD.hhmmss.tar.bz2 YYYY/dir
+

One may also restore modified author/author_handle.json files using:

+
tar -jxvf /var/tmp/YYYY_dir.YYYYMMDD.hhmmss.tar.bz2 author
+

NOTE: This interactive tool (unless -i input_data is used) does +NOT perform all of the steps needed to make a directory a new winning +IOCCC entry. For example, files such as README.md and/or index.html +might contain “XXX” patterns indicating where the Judges +need to add content. Moreover, the Makefile and .gitignore files +need to be examined for suitability, etc.

+

HINT: Executing this tool on your submission will NOT make you an IOCCC winner. :-)

entry2csv.sh

@@ -773,6 +791,21 @@ page.

1984/anonymous.

This tool is used in the bin/md2html.cfg file as part of the md2html tool.

+
+

new-dir.sh

+
+

This tool is used by the Judges as one of the +steps needed to announce a new winning IOCCC entry.

+

Usage:

+
    mkdir -p YYYY/dir
+    bin/new-dir.sh YYYY/dir
+

Here, YYYY/dir must be the path to the winning IOCCC entry.

+

NOTE: This tool does NOT perform all of the steps needed +to make a directory a new winning IOCCC entry. It only starts the +framework for doing so, creating a situation where the +cvt-submission tool be be run.

+

This tool can modify the top level .allyear file, and YYYY/Makefile files.

+

HINT: Executing this tool on your submission will NOT make you an IOCCC winner. :-)

new-year.sh

diff --git a/bin/add-dir.sh b/bin/new-dir.sh similarity index 99% rename from bin/add-dir.sh rename to bin/new-dir.sh index f9d0a739a..92717d145 100755 --- a/bin/add-dir.sh +++ b/bin/new-dir.sh @@ -1,9 +1,9 @@ #!/usr/bin/env bash # -# add-dir.sh - add a new entry directory under an IOCCC year +# new-dir.sh - add a new entry directory under an IOCCC year # # We update YYYY/.year to reference a new entry directory under -# a given IOCCC year. +# a given IOCCC year. We also update the to level `.allyear` too. # # Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. # @@ -88,7 +88,7 @@ shopt -s globstar # enable ** to match all files and zero or more directories an # set variables referenced in the usage message # -export VERSION="1.2 2024-08-09" +export VERSION="1.3 2024-08-11" NAME=$(basename "$0") export NAME export V_FLAG=0