diff --git a/bin/README.md b/bin/README.md index 9ce771b4c..a1ee623c5 100644 --- a/bin/README.md +++ b/bin/README.md @@ -259,24 +259,28 @@ is of the following form: > YYYY_dir.YYYYMMDD.hhmmss.tar.bz2 +Here "_YYYYMMDD.hhmmss_" is a date and timestamp from when the tool was executed. + 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 +``` + 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 +``` + tar -jxvf /var/tmp/YYYY_dir.YYYYMMDD.hhmmss.tar.bz2 author ``` +This tool will form `YYYY/dir/README.md` if needed, from `YYYY/dir/remarks.md`, +`template/entry/README.md.head`, and `template/entry/README.md.tail`. **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) +IOCCC entry. For example, files such as `YYYY/dir/README.md` and/or `YYYY/dir/index.html` +might contain "_triple X_" patterns indicating where the [Judges](../judges.html) need to add content. Moreover, the `Makefile` and `.gitignore` files need to be examined for suitability, etc. @@ -707,6 +711,9 @@ framework for doing so, creating a situation where the This tool can modify the top level `.allyear` file, and `YYYY/Makefile` files. +**NOTE**: This tool assumes that [new-year.sh](#new_year) was executed to create +the prerequisite `YYYY` directory and related files. + **HINT**: Executing this tool on your submission will **NOT** make you an IOCCC winner. :-) @@ -717,13 +724,22 @@ This tool can modify the top level `.allyear` file, and `YYYY/Makefile` files. This tool is used by the [Judges](../judges.html) as part of the final steps to announce a new set of winning IOCCC entries. +This tool may modify the top level `.top` and `Makefile` files. +It will form `YYYY/Makefile` and/or `YYYY/.year` if needed. +It will form `YYYY/README.md` if needed, from `template/README.md.year`. + +**NOTE**: This tool **NOT** perform all of the steps needed to make a new IOCCC year directory. +For example, files such as `YYYY/README.md` and/or `YYYY/index.html` +might contain "_triple X_" patterns indicating where the [Judges](../judges.html) +need to add content. + Usage: ``` bin/new-year.sh -v 1 YYYY ``` -Here, `YYYY` must be a new 4-digit IOCCC year. +Here, `YYYY` must be a new 4-digit (happy :-)) new IOCCC year.
diff --git a/bin/index.html b/bin/index.html index 5b91a4c52..8c8bcb5cf 100644 --- a/bin/index.html +++ b/bin/index.html @@ -556,16 +556,19 @@ is of the following form:

YYYY_dir.YYYYMMDD.hhmmss.tar.bz2

+

Here “YYYYMMDD.hhmmss” is a date and timestamp from when the tool was executed.

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
+
    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
+
    tar -jxvf /var/tmp/YYYY_dir.YYYYMMDD.hhmmss.tar.bz2 author
+

This tool will form YYYY/dir/README.md if needed, from YYYY/dir/remarks.md, +template/entry/README.md.head, and template/entry/README.md.tail.

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 +IOCCC entry. For example, files such as YYYY/dir/README.md and/or YYYY/dir/index.html +might contain “triple X” 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. :-)

@@ -805,15 +808,24 @@ 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.

+

NOTE: This tool assumes that new-year.sh was executed to create +the prerequisite YYYY directory and related files.

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

new-year.sh

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

+

This tool may modify the top level .top and Makefile files. +It will form YYYY/Makefile and/or YYYY/.year if needed. +It will form YYYY/README.md if needed, from template/README.md.year.

+

NOTE: This tool NOT perform all of the steps needed to make a new IOCCC year directory. +For example, files such as YYYY/README.md and/or YYYY/index.html +might contain “triple X” patterns indicating where the Judges +need to add content.

Usage:

    bin/new-year.sh -v 1 YYYY
-

Here, YYYY must be a new 4-digit IOCCC year.

+

Here, YYYY must be a new 4-digit (happy :-)) new IOCCC year.

output-index-inventory.sh

diff --git a/bin/new-dir.sh b/bin/new-dir.sh index 92717d145..a661bb031 100755 --- a/bin/new-dir.sh +++ b/bin/new-dir.sh @@ -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.3 2024-08-11" +export VERSION="1.3.1 2024-08-11" NAME=$(basename "$0") export NAME export V_FLAG=0 @@ -385,8 +385,8 @@ if [[ -z $NOOP ]]; then # append entry directory path to .year # - if [[ $V_FLAG -ge 3 ]]; then - echo "$0: debug[3]: appending YYYY_DIR: $YYYY_DIR to: $DOT_YEAR" 1>&2 + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: making sure that YYYY_DIR: $YYYY_DIR is in: $DOT_YEAR" 1>&2 fi echo "$YYYY_DIR" >> "$DOT_YEAR" @@ -406,8 +406,8 @@ if [[ -z $NOOP ]]; then # firewall - verify YYYY_DIR in .year # if grep -E -q "^$YYYY_DIR$" "$DOT_YEAR"; then - if [[ $V_FLAG -ge 1 ]]; then - echo "$0: debug[1]: YYYY_DIR: $YYYY_DIR is in: $DOT_YEAR" 1>&2 + if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: YYYY_DIR: $YYYY_DIR is in: $DOT_YEAR" 1>&2 fi else echo "$0: ERROR: failed to add YYYY_DIR: $YYYY_DIR to: $DOT_YEAR" 1>&2 @@ -472,8 +472,8 @@ if [[ -z $NOOP ]]; then # case: Makefile file changed, update the file # - if [[ $V_FLAG -ge 5 ]]; then - echo "$0: debug[5]: about to: mv -f -- $TMP_MAKEFILE $MAKE_FILE" 1>&2 + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: about to: mv -f -- $TMP_MAKEFILE $MAKE_FILE" 1>&2 fi if [[ $V_FLAG -ge 3 ]]; then mv -f -v -- "$TMP_MAKEFILE" "$MAKE_FILE" @@ -512,6 +512,9 @@ if [[ -z $NOOP ]]; then if [[ $V_FLAG -ge 1 ]]; then echo "$0: debug[1]: make genpath complete" 1>&2 fi + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: ready for: bin/cvt-submission.sh -v $V_FLAG $YYYY_DIR" 1>&2 + fi # case: with -n #