From fa6458fd40e4b64ca5e69535c1650fbf2f6fca1a Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Sat, 18 Jan 2025 12:18:12 -0800 Subject: [PATCH] update use of chkentry to use new arg order The `chkentry(1)` tool was changed so that the `.auth.json` arg comes before the `.info.json` arg. These changes are needed to accommodate and document that change. Also the use of the single arg as a directory was removed from documentation (until issue #940 is addressed). --- bin/cvt-submission.sh | 14 +++++++------- faq.html | 16 ++++++---------- faq.md | 14 +++++--------- sitemap.xml | 6 +++--- 4 files changed, 21 insertions(+), 29 deletions(-) diff --git a/bin/cvt-submission.sh b/bin/cvt-submission.sh index 45008ddb8..1d28fa049 100755 --- a/bin/cvt-submission.sh +++ b/bin/cvt-submission.sh @@ -22,7 +22,7 @@ # # "Because sometimes even the IOCCC Judges need some help." :-) # -# Copyright (c) 2024 by Landon Curt Noll. All Rights Reserved. +# Copyright (c) 2024-2025 by Landon Curt Noll. All Rights Reserved. # # Permission to use, copy, modify, and distribute this software and # its documentation for any purpose and without fee is hereby granted, @@ -106,7 +106,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.1 2024-11-16" +export VERSION="1.3.2 2025--1-18" NAME=$(basename "$0") export NAME export V_FLAG=0 @@ -1253,19 +1253,19 @@ fi # perform the semantic check on .info.json and .auth.json # if [[ $V_FLAG -ge 1 ]]; then - echo "$0: debug[1]: about to run: $CHKENTRY_TOOL -v 1 -- $INFO_JSON $AUTH_JSON" 1>&2 - "$CHKENTRY_TOOL" -v 1 -- "$INFO_JSON" "$AUTH_JSON" + echo "$0: debug[1]: about to run: $CHKENTRY_TOOL -v 1 -- $AUTH_JSON $INFO_JSON" 1>&2 + "$CHKENTRY_TOOL" -v 1 -- "$AUTH_JSON" "$INFO_JSON" status="$?" if [[ $status -ne 0 ]]; then - echo "$0: ERROR: $CHKENTRY_TOOL -v 1 -- $INFO_JSON $AUTH_JSON failed," \ + echo "$0: ERROR: $CHKENTRY_TOOL -v 1 -- $AUTH_JSON $INFO_JSON failed," \ "error code: $status" 1>&2 exit 7 fi else - "$CHKENTRY_TOOL" -- "$INFO_JSON" "$AUTH_JSON" + "$CHKENTRY_TOOL" -- "$AUTH_JSON" "$INFO_JSON" status="$?" if [[ $status -ne 0 ]]; then - echo "$0: $CHKENTRY_TOOL -- $INFO_JSON $AUTH_JSON failed," \ + echo "$0: $CHKENTRY_TOOL -- $AUTH_JSON $INFO_JSON failed," \ "error code: $status" 1>&2 exit 7 fi diff --git a/faq.html b/faq.html index 639d04483..a31b05aa3 100644 --- a/faq.html +++ b/faq.html @@ -1494,20 +1494,16 @@ and FAQ on “.info.json” for more details on these files.

The chkentry(1) tool accepts more than one command line form. -If you pass a single argument, it is expected to be a directory that has both -.auth.json and .info.json in it. You can also specify a .auth.json and/or +You may specify a .auth.json and/or .info.json file. An argument of “.” will skip that file. For instance:

-
    # test entry directory test_work:
-    chkentry test_work
-
-    # run checks on .info.json:
-    chkentry .info.json .
+
    # run checks on .info.json:
+    chkentry . .info.json
 
     # run checks on .auth.json:
-    chkentry . .auth.json
+    chkentry .auth.json .
 
-    # run checks on .info.json and .auth.json:
-    chkentry .info.json .auth.json

+    # run checks on .auth.json and .info.json:
+    chkentry .auth.json .info.json

If there is a JSON issue detected by the jparse(3) API, then there is a JSON error and chkentry(1) will report it as an error. If the parsing is OK (i.e. valid diff --git a/faq.md b/faq.md index 88acd5704..14d96e603 100644 --- a/faq.md +++ b/faq.md @@ -1336,22 +1336,18 @@ FAQ on "[.info.json](#info_json)" for more details on these files. The `chkentry(1)` tool accepts more than one command line form. -If you pass a single argument, it is expected to be a directory that has both -`.auth.json` and `.info.json` in it. You can also specify a `.auth.json` and/or +You may specify a `.auth.json` and/or `.info.json` file. An argument of "`.`" will skip that file. For instance: ``` - # test entry directory test_work: - chkentry test_work - # run checks on .info.json: - chkentry .info.json . + chkentry . .info.json # run checks on .auth.json: - chkentry . .auth.json + chkentry .auth.json . - # run checks on .info.json and .auth.json: - chkentry .info.json .auth.json + # run checks on .auth.json and .info.json: + chkentry .auth.json .info.json ``` If there is a [JSON](https://www.json.org/json-en.html) issue detected by the diff --git a/sitemap.xml b/sitemap.xml index a65dfb7c6..30e8c635d 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -15210,7 +15210,7 @@ https://www.ioccc.org/bin/cvt-submission.sh - 2025-01-10T06:06:40+00:00 + 2025-01-18T20:11:54+00:00 https://www.ioccc.org/bin/entry2csv.sh @@ -15414,11 +15414,11 @@ https://www.ioccc.org/faq.html - 2025-01-18T16:34:05+00:00 + 2025-01-18T20:15:51+00:00 https://www.ioccc.org/faq.md - 2025-01-18T16:33:38+00:00 + 2025-01-18T20:13:22+00:00 https://www.ioccc.org/inc/index.html