coreutils
[Top][All Lists]
Advanced

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

[PATCH] doc: use @xref{... only at start of a sentence


From: Jim Meyering
Subject: [PATCH] doc: use @xref{... only at start of a sentence
Date: Mon, 16 Apr 2012 23:02:09 +0200

Trying a new syntax-check suggested by Akim Demaille (under development),
here are fixes for the things it catches in coreutils.texi:

>From a2a1e031b4b75a6e805426a7920df809f60a2890 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Mon, 16 Apr 2012 20:26:41 +0200
Subject: [PATCH] doc: use @xref{... only at start of a sentence

* doc/coreutils.texi: Correct many misuses of @xref.
---
 doc/coreutils.texi |   16 +++++++++-------
 doc/perm.texi      |    4 ++--
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index 682536a..4861925 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -2366,7 +2366,7 @@ pr invocation
 @cindex time formats
 @cindex formatting times
 Format header dates using @var{format}, using the same conventions as
-for the command @samp{date +@var{format}}; @xref{date invocation}.
+for the command @samp{date +@var{format}}.  @xref{date invocation}.
 Except for directives, which start with
 @samp{%}, characters in @var{format} are printed unchanged.  You can use
 this option to specify an arbitrary string in place of the header date,
@@ -4910,7 +4910,7 @@ ptx invocation
 limitations and changing several of the program's default option values.
 When @option{-G} is not specified, @sc{gnu} extensions are always enabled.
 @sc{gnu} extensions to @command{ptx} are documented wherever appropriate in 
this
-document.  For the full list, see @xref{Compatibility in ptx}.
+document.  @xref{Compatibility in ptx} for the full list.

 Individual options are explained in the following sections.

@@ -5047,8 +5047,9 @@ Input processing in ptx

 On each input line, the leading sequence of non-white space characters will be
 taken to be a reference that has the purpose of identifying this input
-line in the resulting permuted index.  For more information about reference
-production, see @xref{Output formatting in ptx}.
+line in the resulting permuted index.
+@xref{Output formatting in ptx}
+for more information about reference production.
 Using this option changes the default value for option @option{-S}.

 Using this option, the program does not try very hard to remove
@@ -16000,7 +16001,7 @@ timeout invocation
 @opindex --signal
 Send this @var{signal} to @var{command} on timeout, rather than the
 default @samp{TERM} signal. @var{signal} may be a name like @samp{HUP}
-or a number. Also see @xref{Signal specifications}.
+or a number. @xref{Signal specifications}.
 @end table

 @cindex time units
@@ -16108,8 +16109,9 @@ kill invocation
 signal.  A signal name can be given in canonical form or prefixed by
 @samp{SIG}.  The case of the letters is ignored, except for the
 @option{-@var{signal}} option which must use upper case to avoid
-ambiguity with lower case option letters.  For a list of supported
-signal names and numbers see @xref{Signal specifications}.
+ambiguity with lower case option letters.
+@xref{Signal specifications} for a list of supported
+signal names and numbers.

 @node Delaying
 @chapter Delaying
diff --git a/doc/perm.texi b/doc/perm.texi
index 95de46a..6c466f2 100644
--- a/doc/perm.texi
+++ b/doc/perm.texi
@@ -503,9 +503,9 @@ Numeric Modes
 mode, but it is limited in that normally it cannot take into account the
 previous file mode bits; it can only set them absolutely.
 The set-user-ID and set-group-ID bits of directories are an exception
-to this general limitation; @xref{Directory Setuid and Setgid}.
+to this general limitation.  @xref{Directory Setuid and Setgid}.
 Also, operator numeric modes can take previous file mode bits into
-account; @xref{Operator Numeric Modes}.
+account.  @xref{Operator Numeric Modes}.

 The permissions granted to the user,
 to other users in the file's group,
--
1.7.10.169.g146fe



reply via email to

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