Replace source catalog with metadata file

[Shushe] / README.markdown

diff --git a/README.markdown b/README.markdown
index d459604c1709aaf9632bf19b1600e85521461d1f..b3789ad52731f96b6f68c85470bfe414c4ed53cf 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -24,7 +24,7 @@ It aims to do this with zero dependencies beyond the programs already
   installed on your computer†.
 
 † Assuming an operating system with a fairly featureful, and
   installed on your computer†.
 
 † Assuming an operating system with a fairly featureful, and

-  Posix‐compliant, development setup (e·g, macOS).
+  Posix‐compliant, development setup (e·g, Macintosh ≥ version 10.8).

 In fact, on Linux you will probably need to install a few programs:
   `libxml2-utils`, `xsltproc`, `sharutils`, and `pax`.
 
 In fact, on Linux you will probably need to install a few programs:
   `libxml2-utils`, `xsltproc`, `sharutils`, and `pax`.
 


@@ -51,23 +51,33 @@ In Ascii environments, ⛩️📰 书社 should be written `Shushe`, following
 ## Prerequisites
 
 In most cases, ⛩️📰 书社 aims to require only functionality which is
 ## Prerequisites
 
 In most cases, ⛩️📰 书社 aims to require only functionality which is

-  present in all Posix‐compliant operating systems.
+  present in all Posix‐compliant (`POSIX.1-2001`) operating systems.

 There are a few exceptions.
 Details on particular programs are given below; if a program is not
   listed, it is assumed that any Posix‐compliant implementation will
   work.
 
 There are a few exceptions.
 Details on particular programs are given below; if a program is not
   listed, it is assumed that any Posix‐compliant implementation will
   work.
 

-### `date`
-
-This is a Posix utility, but ⛩️📰 书社 currently depends on
-  unspecified behaviour.
-When the G·N·U version of `stat` is being used, then the G·N·U version
-  of `date` is also expected.
+### `diff`
+
+This is a Posix utility, but ⛩️📰 书社 depends on functionality
+  introduced after `POSIX.1-2001` (the `-u` option, introduced in
+  `POSIX.1-2008`).
+Macintosh systems somewhat interestingly implement this option
+  correctly in legacy mode (`COMMAND_MODE=legacy`) but incorrectly by
+  default (despite claiming `POSIX.1-2008` conformance for this
+  utility).
+[Note this erroneous comment claiming nanosecond & timezone are
+  extensions rather than standardized.][rdar-92753335]
+Despite this, the default Macintosh implementation will still work with
+  ⛩️📰 书社, with the caveat that the timestamp will only include a
+  fractional component when a Posix⹀compliant (e·g, Macintosh legacy or
+  G·N·U) implementation is used.

 
 ### `file`
 
 
 ### `file`
 

-This is a Posix utility, but ⛩️📰 书社 currently depends on
-  unspecified behaviour.
+This is a Posix utility, but it was considered optional in
+  `POSIX.1-2001` (altho it was made mandatory in `POSIX.1-2008`) and
+  ⛩️📰 书社 currently depends on unspecified behaviour.

 It requires support for the following additional options :⁠—
 
 - **`-C`**, when supplied with `-m`, must be useable to compile a
 It requires support for the following additional options :⁠—
 
 - **`-C`**, when supplied with `-m`, must be useable to compile a


@@ -95,8 +105,9 @@ To disable it, set `GIT=`.
 
 ### `make`
 
 
 ### `make`
 

-This is a Posix utility, but ⛩️📰 书社 currently depends on
-  unspecified behaviour.
+This is a Posix utility, but it is considered an optional Software
+  Development utility and ⛩️📰 书社 currently depends on unspecified
+  behaviour.

 ⛩️📰 书社 requires specifically the G·N·U version of `make`, and
   depends on functionality present in version 3.81 or later.
 It is not expected to work in previous versions, or with other
 ⛩️📰 书社 requires specifically the G·N·U version of `make`, and
   depends on functionality present in version 3.81 or later.
 It is not expected to work in previous versions, or with other


@@ -104,34 +115,30 @@ It is not expected to work in previous versions, or with other
 
 ### `pax`
 
 
 ### `pax`
 

-This is a Posix utility, but not included in the Linux Standard Base or
-  installed by default in many distributions.
-Only `ustar` format support is required.
-
-### `stat`
-
-This is not a Posix utility, and nor is it particularly portable.
-To get around incompatibilities, ⛩️📰 书社 attempts to recognize G·N·U
-  `stat` by searching for the string `GNU` when invoked with the
-  `--version` option, and falls back to B·S·D behaviour otherwise.
+This is a Posix utility, but it is not included in the Linux Standard
+  Base or installed by default in many distributions.
+⛩️📰 书社 only requires support for the `ustar` format.

 
 ### `uudecode` and `uuencode`
 
 
 ### `uudecode` and `uuencode`
 

-These are Posix utilities, but not included in the Linux Standard Base
-  or installed by default in many distributions.
+These are Posix utilities, but they were considered optional in
+  `POSIX.1-2001` (altho they are made mandatory in `POSIX.1-2008`) and
+  they are not included in the Linux Standard Base or installed by
+  default in many distributions.

 The G·N·U [Sharutils](https://www.gnu.org/software/sharutils/) package
 The G·N·U [Sharutils](https://www.gnu.org/software/sharutils/) package

-  can be installed to access them.
+  provides one implementation.

 
 ### `xmlcatalog` and `xmllint`
 
 These are not a Posix utilities.
 
 ### `xmlcatalog` and `xmllint`
 
 These are not a Posix utilities.

-They is a part of `libxml2`, but may need to be installed separately
-  (e·g by the name `libxml2-utils`).
+They are a part of `libxml2`, but may need to be installed separately
+  on some platforms (e·g by the name `libxml2-utils`).

 
 ### `xsltproc`
 
 This is not a Posix utility.
 
 ### `xsltproc`
 
 This is not a Posix utility.

-It is a part of `libxslt`, but may need to be installed separately.
+It is a part of `libxslt`, but may need to be installed separately on
+  some platforms.

 
 ## Basic Usage
 
 
 ## Basic Usage
 


@@ -195,15 +202,16 @@ In every case, you may supply your own implementation by overriding the
 
 - `awk`
 - `cat`
 
 - `awk`
 - `cat`

+- `cd`

 - `cksum`
 - `cp`
 - `date`
 - `cksum`
 - `cp`
 - `date`

+- `diff`

 - `file`
 - `find`
 - `git` (optional; set `GIT=` to disable)
 - `grep`
 - `ln`
 - `file`
 - `find`
 - `git` (optional; set `GIT=` to disable)
 - `grep`
 - `ln`

-- `ls`

 - `mkdir`
 - `mv`
 - `od`
 - `mkdir`
 - `mv`
 - `od`


@@ -212,7 +220,6 @@ In every case, you may supply your own implementation by overriding the
 - `rm`
 - `sed`
 - `sleep`
 - `rm`
 - `sed`
 - `sleep`

-- `stat` (BSD *or* GNU)

 - `test`
 - `touch`
 - `tr`
 - `test`
 - `touch`
 - `tr`


@@ -276,6 +283,8 @@ The following additional variables can be used to control the behaviour
     those which end with a cloparen, and those which contain a hash,
     buck, percent, asterisk, colon, semi, eroteme, bracket, backslash,
     or pipe.
     those which end with a cloparen, and those which contain a hash,
     buck, percent, asterisk, colon, semi, eroteme, bracket, backslash,
     or pipe.

+  It is important that these rules not produce any output, as anything
+    printed to `stdout` will be considered a result of the find.

 
 - **`EXTRAFINDRULES`:**
   The value of this variable is appended to `FINDRULES` by default, to
 
 - **`EXTRAFINDRULES`:**
   The value of this variable is appended to `FINDRULES` by default, to


@@ -307,8 +316,13 @@ The following additional variables can be used to control the behaviour
     enable additional transforms without overriding the existing ones.
 
 - **`XMLTYPES`:**
     enable additional transforms without overriding the existing ones.
 
 - **`XMLTYPES`:**

-  A white·space‐separated list of media types to consider X·M·L
-    (default: `application/xml text/xml`).
+  A white·space‐separated list of media types or media type suffixes to
+    consider X·M·L (default: `application/xml text/xml +xml`).
+
+- **`FINALIZE`:**
+  A program to run on (unspecial) X·M·L files after they are
+    transformed (default: `xmllint --nonet --nsclean`).
+  This variable can be used for postprocessing.

 
 - **`THISREV`:**
   The current version of ⛩️📰 书社 (default: derived from the current
 
 - **`THISREV`:**
   The current version of ⛩️📰 书社 (default: derived from the current


@@ -318,6 +332,15 @@ The following additional variables can be used to control the behaviour
   The current version of the source files (default: derived from the
     current git tag/branch/commit).
 
   The current version of the source files (default: derived from the
     current git tag/branch/commit).
 

+- **`QUIET`:**
+  If this variable has a value, informative messages will not be
+    printed (default: empty).
+  Informative messages print to stderr, not stdout, so disabling them
+    usually shouldn’t be necessary.
+  This does not (cannot) disable messages from Make itself, for which
+    the `-s`, `--silent` ∕ `--quiet` Make option is more likely to be
+    useful.
+

 - **`VERBOSE`:**
   If this variable has a value, every recipe instruction will be
     printed when it runs (default: empty).
 - **`VERBOSE`:**
   If this variable has a value, every recipe instruction will be
     printed when it runs (default: empty).


@@ -350,14 +373,12 @@ Source files whose media type does not have an associated X·S·L·T
   contain Ascii white·space, colons (`:`), semis (`;`), pipes (`|`),
   bucks (`$`), percents (`%`), hashes (`#`), asterisks (`*`), brackets
   (`[` or `]`), erotemes (`?`), backslashes (`\`), or control
   contain Ascii white·space, colons (`:`), semis (`;`), pipes (`|`),
   bucks (`$`), percents (`%`), hashes (`#`), asterisks (`*`), brackets
   (`[` or `]`), erotemes (`?`), backslashes (`\`), or control

-  characters, must not begin with a hyphen‐minus (`-`), must not end
-  with a cloparen (`)`), and must not contain quoted braces (`"{` or
-  `}"`).**
+  characters, must not begin with a hyphen‐minus (`-`), and must not end
+  with a cloparen (`)`).**

 The former characters have the potential to conflict with make syntax,
 The former characters have the potential to conflict with make syntax,

-  a leading hyphen‐minus is confusable for a command‐line argument, a
+  a leading hyphen‐minus is confusable for a commandline argument, and a

   trailing cloparen [activates a bug in G·N·U Make
   trailing cloparen [activates a bug in G·N·U Make

-  3.81](https://stackoverflow.com/questions/17148468/capturing-filenames-including-parentheses-with-gnu-makes-wildcard-function#comment24825307_17148894),
-  and quoted braces are used internally by the program.
+  3.81](https://stackoverflow.com/questions/17148468/capturing-filenames-including-parentheses-with-gnu-makes-wildcard-function#comment24825307_17148894).

 
 ## Parsers
 
 
 ## Parsers
 


@@ -585,8 +606,8 @@ The following params are made available globally in parsers and
 
 The following params are only available in transforms :⁠—
 
 
 The following params are only available in transforms :⁠—
 

-- **`CATALOG`:**
-  The path of the catalog file (within `BUILDDIR`).
+- **`METADATA`:**
+  The path of the metadata file (within `BUILDDIR`).

 
 - **`PATH`:**
   The path of the output file (within `DESTDIR`).
 
 - **`PATH`:**
   The path of the output file (within `DESTDIR`).


@@ -700,29 +721,6 @@ They are :⁠—
   A plaintext (U·T·F‐8) file will be produced from the text nodes in
     the transformation result.
 
   A plaintext (U·T·F‐8) file will be produced from the text nodes in
     the transformation result.
 

-## Pagination
-
-It is possible to have a single source file produce multiple output
-  files via `<书社:page>` elements, whose `@name` gives the name of the
-  page.
-If a parsed document has a `@书社:destination` which contains `%s`,
-  the `%s` will be replaced with the `@name` for each `<书社:page>` (and
-  removed for the main output).
-Otherwise, the `@name` is inserted before the first period of the
-  filename (or at the end of the filename for those with no period).
-If `<书社:page>`s do not have a `@name`, they are numbered
-  sequentially.
-The destination of pages must be in the same directory as their parent.
-
-Pagination essentially forms a limited convenience for the more
-  sophisticated technique of creating an archive with ⛩️📰 书社 and
-  then unarchiving it.
-Pages are, from Make’s point of view, untracked side·effects of
-  installing the main output, meaning they cannot be targeted directly
-  and will not appear in `make list` or `make listout`.
-They are intended solely for the like of indices and feeds, for which
-  convenience and necessity outweigh their flaws.
-

 ## License
 
 This repository conforms to [REUSE][].
 ## License
 
 This repository conforms to [REUSE][].


@@ -732,3 +730,4 @@ Most source files are licensed under the terms of the <cite>Mozilla
 
 [REUSE]: <https://reuse.software/spec/>
 [draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
 
 [REUSE]: <https://reuse.software/spec/>
 [draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>

+[rdar-92753335]: <https://github.com/apple-oss-distributions/patch_cmds/blob/5084833f90df1b0e0924ea56f94c0199b3b8bbc6/diff/diffreg.c#L1800-L1808>