summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Man page: rewrite discussion of QUILT_COLORS configuration variableG. Branden Robinson2022-08-031-85/+83
| | | | | | | | | | | | | | | | | | | | | | 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 call the tbl preprocessor to render the table. Expand the example to be more demonstrative. Add pointers to the ECMA-48 standard document and the console_codes section 4 man page (from Michael Kerrisk's man-pages project, widely available) to the See Also section. [JD: Some fixes, added patch_offs to the table, added a note that the patches command shares colors with the series command]
* Man page: make file tree diagram portableG. Branden Robinson2022-08-031-14/+20
| | | | | | | Use the groff extension .schar to provide an alternative output sequence for output devices missing the Unicode box-drawing characters. [JD: removed a .fi request which I believed was restored by accident]
* Man page: wordsmith Files sectionG. Branden Robinson2022-08-031-39/+60
| | | | | | | | | | | | | | | | | | | | | | | * Give working tree example a name that looks more like an actual software project's directory name. * Fix pronoun/antecedent agreement (multiple occurrences). * Tighten language (e.g., unnecessary use of "some"). * Reorganize discussion of how quilt finds its rc file to proceed strictly in the order attempted. * Leave breadcrumbs about EDITOR and LESS, which used to be part of this discussion; add cross-reference to where the material is now. * Make explicit the fact that quilt command names need to be manually up-cased for use in QUILT_COMMAND_ARGS. * Set configuration variable names in italics. * Transform a popular Denglish construction into idiomatic English. https://english.stackexchange.com/questions/85069/is-the-construction-it-allows-to-proper-english * Clarify that "if set to anything" variables function as Booleans. * Recast "a shortcut to" as "shorthand for", which is more idiomatic English in context. * Add cross-reference to diffstat man page on first occurrence. * Fix typo: each commands -> each command. [JD: reverted 2 changes I did not like; fixes one more typo]
* Man page: wordsmith Environment sectionG. Branden Robinson2022-08-031-8/+6
| | | | | | * Remove dependent clause used as a topic transition when this material was not in its own section. * Provide examples of when $EDITOR is used.
* Man page: wordsmith Exit Status sectionG. Branden Robinson2022-08-031-6/+8
| | | | * Eliminate otherwise unused term "sub-command".
* Man page: wordsmith Options sectionG. Branden Robinson2022-08-031-5/+6
| | | | | | | | * Don't introduce a metavariable without explaining it or using it in context. * Drop the reference to the PDF documentation which doesn't belong there. * Clarify options --trace and --version.
* Man page: wordsmith Description sectionG. Branden Robinson2022-08-031-48/+69
| | | | | | | | | | | | | | | | | | * Don't end a sentence with an abbreviation period if possible (also, man-pages(7) discourages the use of Latin abbreviations altogether). * Users of quilt are not merely outputting patches; they are consuming them and altering them as well. * Clarify the (shall we say) truncability of command names. * Use directional double-quotes instead of boldface to set off literals. Some typographers claim that frequent font face changes tire the eye. * Offer an example of a patch name. * Introduce the "quilt series" command in the same paragraph the series file itself is first described, to eliminate forward reference. * Introduce quilt command names only once each. * Add a paragraph summarizing the work cycle for starting and refining a new patch. [JD: Some editions and clean-ups]
* Man page: sort options in alphabetical order to ease human scanningG. Branden Robinson2022-08-031-4/+4
|
* Man page: change the form of the word "subdirectory"G. Branden Robinson2022-08-031-5/+5
| | | | Per style recommendation in man-pages(7).
* Man page: tighten summaryG. Branden Robinson2022-08-031-1/+1
| | | | Everything in manual sections 1 or 8 is a tool, in some sense.
* Man page: render Andreas Gruenbacher's name with a u-umlautG. Branden Robinson2022-08-031-1/+2
|
* Man page: capitalize "PDF" when not part of a filenameG. Branden Robinson2022-08-031-4/+4
|
* Man page: document -h flag in the Options sectionG. Branden Robinson2022-08-031-0/+10
| | | | Also add a clarifying introductory sentence.
* Man page: set file names and environment variable names in italicsG. Branden Robinson2022-08-031-42/+87
| | | | | | | | Variable content in an italic context is set in roman for contrast, but still in italics in running roman prose. [JD: Revert some of the changes which did not belong there, and restored the original indentation level as I think it looked better]
* Man page: update internal and external cross-referencesG. Branden Robinson2022-08-031-9/+30
| | | | | | | | | | | 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 order.
* Man page: italicize work titlesG. Branden Robinson2022-08-031-52/+107
| | | | ...including names of software projects (such as quilt itself).
* Man page: use "e.g." correctlyG. Branden Robinson2022-08-031-2/+2
| | | | | | | | 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 <https://www.troff.org/54.pdf>.
* Man page: use character escapes for directional quotes and spacing tildeG. Branden Robinson2022-08-031-49/+56
| | | | Also add quotation marks where they make semantic sense.
* Man page: make synopsis comprehensiveG. Branden Robinson2022-08-031-2/+12
| | | | | | | | | | | | | | 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 groff_man(7)'s SY and YS macros for more attractive presentation. [JD: Restore [options] and strip duplicate line]
* Man page: escape ASCII hyphen-minus characters used as suchG. Branden Robinson2022-08-031-31/+32
| | | | | | | | | | | | 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 prepared for UTF-8 terminal and PDF output, possibly among others. See section 2.1 of CSTR #54, "Troff User's Manual", Ossanna & Kernighan <https://www.troff.org/54.pdf>.
* Man page: use groff_man(7)s EX and EE macros for examplesG. Branden Robinson2022-08-031-10/+7
| | | | | | 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".)
* Man page: use font macros instead of font escapesG. Branden Robinson2022-08-031-17/+33
| | | | | Apart from being higher-level and easier to read, the macros get you proper italic corrections when abutting italic with non-italic text.
* Man page: reorganize sectionsG. Branden Robinson2022-08-031-18/+21
| | | | | | | | Use only section names endorsed by man-pages(7), and put them in the recommended order. Use subsection macro (SS) where helpful. [JD: Preserve the EXAMPLE section as EXAMPLES]
* Man page: break input lines at all sentence endingsG. Branden Robinson2022-08-031-119/+165
| | | | | | | Also reflow input lines to 72 columns. Both are recommended by *roff experts: https://www.gnu.org/software/groff/manual/html_node/Input-Conventions.html
* Man page: eliminate or replace blank linesG. Branden Robinson2022-08-031-83/+31
| | | | | | | | | | | | | | | | 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 spacing is usually different from ".sp 1" for typesetter output (this can be seen in PostScript and PDF output). Explicit spacing is also unnecessary immediately adjacent to section headings. See section 5.3 of CSTR #54, "Troff User's Manual", Ossanna & Kernighan <https://www.troff.org/54.pdf>. [JD: Added an empty request (.) before each section to preserve the readability of the input.]
* Man page: the man macro RE is given an argument when it does not need oneG. Branden Robinson2022-08-031-1/+1
| | | | | | | | | | This causes warnings from roff when the warning level is turned up really high, as some roff/man page hackers do. <standard input>:891: warning: number register `an-saved-margin2' not defined <standard input>:891: warning: number register `an-saved-prevailing-indent2' not defined Stop supplying the extraneous argument.
* doc/quilt.pdf: Document the build processJean Delvare2020-06-021-0/+9
| | | | | | | | | Document the list of latex packages that must be installed in order to build the PDF documentation. Suggested by Ondřej Lysoněk. Signed-off-by: Jean Delvare <jdelvare@suse.de>
* Document that quilt loads /etc/quilt.quiltrcOndřej Lysoněk2020-05-182-4/+6
| | | | | | | | quilt loads /etc/quilt.quiltrc if ~/.quiltrc doesn't exist. Document it. Signed-off-by: Ondřej Lysoněk <olysonek@redhat.com> Signed-off-by: Jean Delvare <jdelvare@suse.de>
* doc/quilt.pdf: Fix cross-referencesJean Delvare2020-05-181-2/+8
| | | | | | | | | | | | In order to have cross-references in the PDF documentation, we need a two-pass process, where the first pass prepares the references while the second pass generates the actual PDF. Do that explicitly from now on, so that the cross-references are OK even when building the documentation for the first time. Signed-off-by: Jean Delvare <jdelvare@suse.de> Tested-by: Ondřej Lysoněk <olysonek@redhat.com>
* Regenerate pdf documentation (English version)Jean Delvare2020-05-141-0/+0
|
* doc/main-rus.tex: Fix double dashesJean Delvare2020-05-141-3/+3
| | | | | | | | | | In Latex, a double dash produces an "en dash". If a literal double dash is needed, '-{}-' can be used. Based on a similar fix to the English version of the document by Ondřej Lysoněk. Signed-off-by: Jean Delvare <jdelvare@suse.de>
* doc/main.tex: Fix double dashesOndřej Lysoněk2020-05-141-5/+5
| | | | | | | | In Latex, a double dash produces an "en dash". If a literal double dash is needed, '-{}-' can be used. Signed-off-by: Ondřej Lysoněk <olysonek@redhat.com> Signed-off-by: Jean Delvare <jdelvare@suse.de>
* Man page: Fix a typoOndřej Lysoněk2020-05-141-1/+1
| | | | | | | "Serie" is not a word. Change it to "series". Signed-off-by: Ondřej Lysoněk <olysonek@redhat.com> Signed-off-by: Jean Delvare <jdelvare@suse.de>
* Man page: Document the series file format furtherJean Delvare2019-09-171-2/+7
| | | | | | | | | | Explain how patch options like the strip level can be recoded in the series file. Suggested by Cristian Rigamonti in bug #56886: https://savannah.nongnu.org/bugs/index.php?56886 Signed-off-by: Jean Delvare <jdelvare@suse.de>
* Document QUILT_PC as user-settableJean Delvare2019-03-141-0/+5
| | | | | | | If some users are already changing the value of QUILT_PC and it works, we may as well document it. Signed-off-by: Jean Delvare <jdelvare@suse.de>
* mail: Remove Content-Disposition headersAndreas Gruenbacher2018-07-031-5/+3
| | | | | | | | | | | | The Content-Disposition headers quilt has been adding since 2015 are causing problems with Thunderbird and Gmail, which display patches as attachments instead of text if this header is present and includes a filename. This breaks email-based patch reviewing and isn't likely to get fixed on the email client side, so stop adding those headers. Recipients of patches via email already need a mechanism to construct filenames for messages coming from anything but quilt, so this change is unlikely to cause major problems for existing users.
* Mention guards in quilt manual pageJean Delvare2018-04-061-1/+2
| | | | | | Most people don't know about the guards helper which can be used to generate series files. Mentioning it in the quilt manual page should help raise the awareness.
* Update the release checklistJean Delvare2015-02-101-5/+6
| | | | Translation updates take time so it should be the first item.
* translations need love tooMartin Quinson2014-05-071-0/+4
|
* improve the documentation about the layout of a working directoryMartin Quinson2014-05-041-9/+24
|
* Update the release checklistJean Delvare2014-04-171-3/+3
| | | | | Update doc/RELEASING to mention the NEWS file instead of the quilt.changes file.
* Add step-by-step releasing guideJean Delvare2014-01-271-0/+34
|
* Tree-wide white-space cleanupsJean Delvare2014-01-203-31/+31
| | | | | | | * Delete blank lines at end of files. * Delete white space at end of lines. * Delete spaces before tab. * Replace 8 spaces by a tab where it makes sense.
* Document that -E is no longer passed to patch by defaultJean Delvare2014-01-171-1/+10
| | | | | | | Explain why -E is no longer passed to patch by default, and why a user may want to revert to the old behavior. Based on a preliminary patch by Martin Quinson.
* Fix typoJean Delvare2013-12-181-1/+1
|
* Man page: Document exit statusMartin Quinson2013-12-171-1/+11
| | | | | | | Documentation update: add an EXIT STATUS section to the manual page. Closes Debian bug #587001: http://bugs.debian.org/587001
* Man page: Clarify example sectionMartin Quinson2013-12-171-1/+1
| | | | Add a few words to the example section to make it clearer.
* Document overriding LESS in ~/.quiltrcKent R. Spillner2013-12-171-6/+6
| | | | | | | | Similar to EDITOR, document quilt's use of LESS when paging output. QUILT_LESS_ARGS is unnecessary, so revert 497979e561e880fb0d11be82c78544e5718d531b. Signed-off-by: Kent R. Spillner <kspillner@acm.org> Signed-off-by: Jean Delvare <jdelvare@suse.de>
* scripts: let users override LESS env variable.Kent R. Spillner2013-12-141-0/+6
| | | | | | | | | Add a QUILT_LESS_ARGS variable that can be used to configure what quilt will set LESS to when LESS is undefined. Defaults to -FSRX so no functional change in the default case, but allows users to drop the -F argument as needed (for example, when using a multiline shell prompt) without explicitly setting LESS. Signed-off-by: Kent R. Spillner <kspillner@acm.org>
* document QUILT_COLORSMartin Quinson2013-12-081-6/+74
|
generated by cgit (git 2.34.1) at 2024-09-20 00:14:35 +0000