[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Quilt-dev] [patch v2 12/26] Man page: update internal and external cros
From: |
Jean Delvare |
Subject: |
[Quilt-dev] [patch v2 12/26] Man page: update internal and external cross-references |
Date: |
Tue, 26 Jul 2022 14:43:20 +0200 |
User-agent: |
quilt/0.67 |
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.
---
doc/quilt.1.in | 39 ++++++++++++++++++++++++++++++---------
1 file changed, 30 insertions(+), 9 deletions(-)
--- quilt.orig/doc/quilt.1.in 2022-07-05 22:10:18.138143349 +0200
+++ quilt/doc/quilt.1.in 2022-07-05 22:15:50.494929505 +0200
@@ -61,7 +61,11 @@ By default, most commands apply to the t
.PP
Patch files are located in the
.I patches
-sub-directory of the source tree (see EXAMPLE OF WORKING TREE below).
+sub-directory of the source tree (see
+.BR "Example of working tree" ,
+under
+.BR FILES ,
+below).
The
.I QUILT_PATCHES
environment variable can be used to override this location.
@@ -127,8 +131,9 @@ file.
is careful to preserve all text that precedes the actual patch when
doing a refresh.
(This is limited to patches in unified format; see
-.B diff
-documentation).
+the GNU
+.I Diffutils
+manual.)
.PP
The series file is looked up in the .pc directory, in the root of the
source tree, and in the patches directory.
@@ -427,14 +432,30 @@ This man page was written by Martin Quin
in the pdf documentation, and in the help messages of each commands.
.
.SH EXAMPLE
-Please refer to the pdf documentation for a full example of use.
+Please refer to the pdf documentation for a full example of use (under
+.B "SEE ALSO"
+below).
.
.SH "SEE ALSO"
-The pdf documentation, which should be under @DOCSUBDIR@/quilt.pdf.
+.I "How to Survive with Many Patches, or: Introduction to Quilt"
+is installed at @DOCSUBDIR@/quilt.pdf.
Note that some distributors compress this file.
-.BR zxpdf ( 1 )
+.BR zxpdf (1)
can be used to display compressed pdf files.
.PP
-.BR diff ( 1 ),
-.BR patch ( 1 ),
-.BR guards ( 1 ).
+The GNU
+.I Diffutils
+manual,
+.UR https://\\:www.gnu.org/\\:software/\\:diffutils/\\:manual/
+.I "Comparing and Merging Files"
+.UE ,
+documents
+.I diff
+and
+.I patch
+in detail.
+.PP
+.BR diff (1),
+.BR diffstat (1),
+.BR guards (1),
+.BR patch (1)
- [Quilt-dev] [patch v2 03/26] Man page: break input lines at all sentence endings, (continued)
- [Quilt-dev] [patch v2 03/26] Man page: break input lines at all sentence endings, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 04/26] Man page: reorganize sections, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 05/26] Man page: use font macros instead of font escapes, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 06/26] Man page: use groff_man(7)s EX and EE macros for examples, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 07/26] Man page: escape ASCII hyphen-minus characters used as such, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 08/26] Man page: make synopsis comprehensive, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 09/26] Man page: use character escapes for directional quotes and spacing tilde, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 10/26] Man page: use "e.g." correctly, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 11/26] Man page: italicize work titles, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 12/26] Man page: update internal and external cross-references,
Jean Delvare <=
- [Quilt-dev] [patch v2 13/26] Man page: set filespecs and environment variable names in italics, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 14/26] Man page: document -h flag in the Options section, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 15/26] Man page: capitalize "PDF" when not part of a filename, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 16/26] Man page: render Andreas Gruenbachers name with a u-umlaut, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 17/26] Man page: tighten summary, Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 18/26] Man page: change the form of the word "subdirectory", Jean Delvare, 2022/07/26
- [Quilt-dev] [patch v2 19/26] Man page: sort options in alphabetical order to ease human scanning, Jean Delvare, 2022/07/26