quilt-dev
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Quilt-dev] [patch 04/26] Reorganize sections to use only section names


From: g . branden . robinson
Subject: [Quilt-dev] [patch 04/26] Reorganize sections to use only section names endorsed by man-pages(7), and put them in the recommended order.
Date: Sat, 16 Jun 2018 12:22:36 -0400
User-agent: quilt/0.65

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 automatically removed when they are
 no longer needed, so there is no need to clean up manually.
-.SH QUILT COMMANDS REFERENCE
+.SS Quilt commands reference
 @REFERENCE@
-.SH COMMON OPTIONS TO ALL COMMANDS
+.SH OPTIONS
 .IP \"\\fB--trace\\fP\" 8
 Runs the command in bash trace mode (-x).
 For internal debugging.
@@ -125,7 +125,7 @@ See the pdf documentation for details ab
 The special value \"-\" causes quilt not to read any configuration file.
 .IP \"\\fB--version\\fP\" 8
 Print the version number and exit immediately.
-.SH EXIT STATUS
+.SH "EXIT STATUS"
 The exit status is 0 if the sub-command was successfully executed, and
 1 in case of error.
 .PP
@@ -134,7 +134,18 @@ the command.
 This happens in particular when asking to push when the whole stack is
 already pushed, or asking to pop when the whole stack is already popped.
 This behavior is intended to ease the scripting around quilt.
-.SH EXAMPLE OF WORKING TREE
+.SH ENVIRONMENT
+In addition to that, quilt recognizes the following variables:
+.IP EDITOR 4
+The program to run to edit files.
+If it isn't redefined in the configuration file, $EDITOR as defined in
+the environment will be used.
+.IP LESS 4
+The arguments used to invoke the pager.
+Inherits the existing value of $LESS if LESS is already set in the
+environment, otherwise defaults to "-FRSX".
+.SH FILES
+.SS "Example of working tree"
 .fam C
 .RS
 .nf
@@ -166,9 +177,7 @@ Changing its content is not advised.
 This directory can usually be regenerated from the initial files and the
 content of the patches/ directory (provided that all patches were
 regenerated before the removal).
-.SH EXAMPLE
-Please refer to the pdf documentation for a full example of use.
-.SH CONFIGURATION FILE
+.SS "Configuration file"
 Upon startup, quilt evaluates the file .quiltrc in the user's home
 directory, or the file specified with the --quiltrc option.
 This file is a regular bash script.
@@ -177,15 +186,6 @@ QUILT_${COMMAND}_ARGS variable.
 For example, QUILT_DIFF_ARGS="--color=auto" causes the output of quilt
 diff to be syntax colored when writing to a terminal.
 .PP
-In addition to that, quilt recognizes the following variables:
-.IP EDITOR 4
-The program to run to edit files.
-If it isn't redefined in the configuration file, $EDITOR as defined in
-the environment will be used.
-.IP LESS 4
-The arguments used to invoke the pager.
-Inherits the existing value of $LESS if LESS is already set in the
-environment, otherwise defaults to "-FRSX".
 .IP QUILT_DIFF_OPTS 4
 Additional options that quilt shall pass to GNU diff when generating
 patches.
@@ -319,7 +319,7 @@ in the distribution).
 .PP
 This man page was written by Martin Quinson, based on information found
 in the pdf documentation, and in the help messages of each commands.
-.SH SEE ALSO
+.SH "SEE ALSO"
 The pdf documentation, which should be under @DOCSUBDIR@/quilt.pdf.
 Note that some distributors compress this file.
 .BR zxpdf ( 1 )




reply via email to

[Prev in Thread] Current Thread [Next in Thread]