[Quilt-dev] [patch 19/26] Sort options in alphabetical order to ease human scanning.

2018-06-16 Thread g . branden . robinson
Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -160,10 +160,6 @@ if one is specified, otherwise for .I quilt itself) and exit. .TP -.B \\-\\-trace -Runs the command in bash trace mode

[Quilt-dev] [patch 22/26] Wordsmith Exit Status section.

2018-06-16 Thread g . branden . robinson
* Eliminate otherwise unused term "sub-command". Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -201,15 +201,17 @@ internal operations. .B \\-\\-version prints the version number and

[Quilt-dev] [patch 26/26] Rewrite discussion of QUILT_COLORS configuration variable.

2018-06-16 Thread g . branden . robinson
These are ANSI escape sequences as defined by ECMA-48; recast the entire discussion in light of that fact. Condense the many tagged paragraphs with a templated discussion of defaults into a table. Sort the QUILT_COLORS format names into alphabetical order. Add a hint to the formatter (man) to

[Quilt-dev] [patch 25/26] Make file tree diagram portable.

2018-06-16 Thread g . branden . robinson
Use the groff extension .schar to provide an alternative output sequence for output devices missing the Unicode box-drawing characters. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -229,23

[Quilt-dev] [patch 14/26] Document -h flag in the Options section.

2018-06-16 Thread g . branden . robinson
Also add a clarifying introductory sentence. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -149,6 +149,16 @@ there is no need to clean up manually. .SS Quilt commands reference

[Quilt-dev] [patch 02/26] Eliminate or replace blank lines.

2018-06-16 Thread g . branden . robinson
Blank lines are bad roff style. Per CSTR #54, blank lines are the equivalent of ".sp 1", but in GNU roff this can be overridden with a blank line macro (".blm"), and all macro packages for text formatting (mm, ms, me, man, etc.) have macros for paragraph separation, and the inter-paragraph

[Quilt-dev] [patch 01/26] The man macro RE is given an argument when it does not need one.

2018-06-16 Thread g . branden . robinson
This causes warnings from roff when the warning level is turned up really high, as some roff/man page hackers do. :891: warning: number register `an-saved-margin2' not defined :891: warning: number register `an-saved-prevailing-indent2' not defined Stop supplying the extraneous argument.

[Quilt-dev] [patch 07/26] Escape ASCII hyphen-minus characters used as such.

2018-06-16 Thread g . branden . robinson
When a "literal" ASCII 45 hyphen-minus character is desired, it has to be escaped; this is a requirement going all the way back to Bell Labs Troff, but is frequently overlooked. Getting it right enables accurate cut-and-paste of code examples, filenames, URLs, and so forth from roff documents

[Quilt-dev] [patch 09/26] Use character escapes for directional quotes and spacing tilde.

2018-06-16 Thread g . branden . robinson
Also add quotation marks where they make semantic sense. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -86,8 +86,8 @@ Different series files can be used to as ways, corresponding for

[Quilt-dev] [patch 04/26] Reorganize sections to use only section names endorsed by man-pages(7), and put them in the recommended order.

2018-06-16 Thread g . branden . robinson
Use subsection macro (SS) where helpful. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -112,9 +112,9 @@ and refreshing patches .RB ( "quilt refresh" ). Files in the .pc directory are

[Quilt-dev] [patch 12/26] Update internal and external cross-references.

2018-06-16 Thread g . branden . robinson
Embolden internal subsection reference, and refer to its parent section. Point explicitly to the GNU Diffutils manual regarding unified diff format, and add cross-reference in the See Also section. Add cross-reference to diffstat man page. Sort man page cross-reference list in alphabetical

[Quilt-dev] [patch 00/26] doc/quilt.1.in refactor revisited

2018-06-16 Thread g . branden . robinson
Hi folks, Last month I sent a message[1] with a monolith of changes to the quilt man page. Here it is, improved (IMO), and in a form I hope is friendlier and easier to integrate. Thanks to Andreas Grünbacher and Jean Delvare for their encouragement. [1]

[Quilt-dev] [patch 03/26] Break input lines at all sentence endings.

2018-06-16 Thread g . branden . robinson
Also reflow input lines to 72 columns. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -8,19 +8,24 @@ quilt \\- tool to manage series of patch [-h] command [options] .SH DESCRIPTION Quilt

[Quilt-dev] [patch 11/26] Italicize work titles.

2018-06-16 Thread g . branden . robinson
...including names of software projects (such as quilt itself). Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -18,22 +18,31 @@ quilt \\- tool to manage series of patch .SY "quilt

[Quilt-dev] [patch 18/26] Change the form of the word "subdirectory".

2018-06-16 Thread g . branden . robinson
Per style recommendation in man-pages(7). Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -59,7 +59,7 @@ By default, most commands apply to the t .PP Patch files are located in the .I

[Quilt-dev] [patch 06/26] Use groff_man(7)s EX and EE macros for examples.

2018-06-16 Thread g . branden . robinson
This eliminates the use of low-level requests in this man page (the groffism ".fam" to change the font family and the switching off and on of fill mode with ".nf" and ".fi".) Index: quilt/doc/quilt.1.in === ---

[Quilt-dev] [patch 08/26] Make synopsis comprehensive.

2018-06-16 Thread g . branden . robinson
Document --quiltrc, --trace, and --version options explicitly. Separate the informational operation modes for reporting help and version information. Mark up synopsis canonically (literals in bold, variable content in italics, and roman for "synopsis language" (option brackets, etc.)). Use

[Quilt-dev] [patch 16/26] Render Andreas Gruenbachers name with a u-umlaut.

2018-06-16 Thread g . branden . robinson
Revised 2018-06-07 to rename patch and use .schar instead of string definition. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -447,10 +447,11 @@ QUILT_COLORS='diff_hdr=35;44' .RE .EE .SH

[Quilt-dev] [patch 13/26] Set filespecs and environment variable names in italics.

2018-06-16 Thread g . branden . robinson
Variable content in an italic context is set in roman for contrast, but still in italics in running roman prose. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@ -71,9 +71,7 @@ When not found

[Quilt-dev] [patch 21/26] Wordsmith Options section.

2018-06-16 Thread g . branden . robinson
* Make tagged paragraphs readable as paragraphs (try it aloud). * Don't introduce a metavariable without explaining it or using it in context. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in

[Quilt-dev] [patch 05/26] Use font macros instead of font escapes.

2018-06-16 Thread g . branden . robinson
Apart from being higher-level and easier to read, the macros get you proper italic corrections when abutting italic with non-italic text. Index: quilt/doc/quilt.1.in === --- quilt.orig/doc/quilt.1.in +++ quilt/doc/quilt.1.in @@

[Quilt-dev] [patch 10/26] Use "e.g." correctly.

2018-06-16 Thread g . branden . robinson
The Latin "exempli gratia" is abbreviated "e.g.". Also, use a zero-width-space escape to defeat roff's end-of-sentence detection. See section 4.1 of CSTR #54, "Troff User's Manual", Ossanna & Kernighan . Index: quilt/doc/quilt.1.in