[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 03/13: [docs]: Speak in terms of "the roff language".
From: |
G. Branden Robinson |
Subject: |
[groff] 03/13: [docs]: Speak in terms of "the roff language". |
Date: |
Sat, 16 Apr 2022 04:37:31 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 80afae9f405a038c66d5682368f4069d8f9d0d54
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Apr 13 12:55:00 2022 +1000
[docs]: Speak in terms of "the roff language".
* doc/groff.texi:
* doc/ms.ms:
* man/groff.7.man: Characterize "roff language" in the singular, not the
plural, emphasizing the similarity of extant specimens.
* doc/groff.texi (Conventions Used in This Manual): Add paragraph
discussing denotations of "groff" and "roff".
Fixes <https://savannah.gnu.org/bugs/?62233>. Thanks to John Gardner
and Dave Kemper for the discussion.
---
ChangeLog | 13 +++++++++++++
doc/groff.texi | 20 ++++++++++++++------
doc/ms.ms | 4 ++--
man/groff.7.man | 10 ++++++----
4 files changed, 35 insertions(+), 12 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 74734703..a38ed01f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2022-04-13 G. Branden Robinson <g.branden.robinson@gmail.com>
+
+ * doc/groff.texi:
+ * doc/ms.ms:
+ * man/groff.7.man: Characterize "roff language" in the singular,
+ not the plural, emphasizing the similarity of extant specimens.
+
+ * doc/groff.texi (Conventions Used in This Manual): Add
+ paragraph discussing denotations of "groff" and "roff".
+
+ Fixes <https://savannah.gnu.org/bugs/?62233>. Thanks to John
+ Gardner and Dave Kemper for the discussion.
+
2022-04-12 Ingo Schwarze <schwarze@openbsd.org>
Delete the harmful, ill-designed, buggy, and essentially
diff --git a/doc/groff.texi b/doc/groff.texi
index 9bcefef8..81a862c0 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -878,6 +878,13 @@ and @acronym{PDF}.
@node Conventions Used in This Manual, Credits, Output Device Intro,
Introduction
@section Conventions Used in This Manual
+We apply the term ``groff'' to the language documented here, the GNU
+implementation of the overall system, the project that develops that
+system, and the command of that name. In the first sense, @code{groff}
+is an extended dialect of the @code{roff} language, for which many
+similar implementations exist; see the @cite{roff@r{(7)}} man page for a
+history.
+
We use Texinfo's ``result'' (@result{}) and @error{} notations to
present output written to the standard output and standard error
streams, respectively. Diagnostic messages from the GNU @code{troff}
@@ -4012,7 +4019,7 @@ after each call to @code{.1C}, @code{.2C}, or @code{.MC}.}
contemporary documents. The footnote line length is effectively
computed as @samp{@slanted{column-width} * \*[FR]}. If an absolute
footnote line length is required, recall that arithmetic expressions in
-@code{roff} languages are evaluated strictly from left to right, with no
+@code{roff} input are evaluated strictly from left to right, with no
operator precedence (parentheses are honored).
@Example
@@ -5061,8 +5068,8 @@ when using such low-level features, so most users turn to
the
@node Requests and Macros, Macro Packages, Tab Stops, Text
@subsection Requests and Macros
-We have now encountered almost all of the syntax there is in @code{roff}
-languages, with an exception already noted in passing.
+We have now encountered almost all of the syntax there is in the
+@code{roff} language, with an exception already noted in passing.
@cindex request
@cindex control character
@cindex control character, no-break
@@ -5363,7 +5370,7 @@ Euro @samp{\[Eu]} and per mille @samp{\[%0]} glyphs.}
@cindex conventions for input
Since GNU @code{troff} fills text automatically, it is common practice
-in @code{roff} languages to avoid visual composition of text in input
+in the @code{roff} language to avoid visual composition of text in input
files: the esthetic appeal of the formatted output is what matters.
Therefore, @code{roff} input should be arranged such that it is easy for
authors and maintainers to compose and develop the document, understand
@@ -5927,7 +5934,7 @@ to the canonical truth values @samp{0} and @samp{1}.
@cindex expression, order of evaluation
@opindex (
@opindex )
-@code{roff} languages have no operator precedence:@: expressions are
+The @code{roff} language has no operator precedence:@: expressions are
evaluated strictly from left to right, in contrast to schoolhouse
arithmetic. Use parentheses @code{(} @code{)} to impose a desired
precedence upon subexpressions.
@@ -9348,7 +9355,8 @@ collected line still uses the old line length value.
@cindex line control
@cindex control, line
-GNU @code{troff} distinguishes input and output line continuation.
+The @code{roff} language distinguishes input and output line
+continuation.
@Defesc {\\@key{RET}, , ,}
@cindex input line continuation (@code{\@key{RET}})
diff --git a/doc/ms.ms b/doc/ms.ms
index d0e93191..55164c5b 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -2512,9 +2512,9 @@ The footnote line length is effectively computed as
.CW "\~*\~\[rs]*[FR]" \[rq].
.
If an absolute footnote line length is required,
-recall that arithmetic expressions in
+recall that arithmetic expressions in the
.I roff
-languages are evaluated strictly from left to right,
+language are evaluated strictly from left to right,
with no operator precedence
(parentheses are honored).
.
diff --git a/man/groff.7.man b/man/groff.7.man
index 9cb417c6..ac54d08c 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -280,9 +280,9 @@ may be available in
.
.P
.I groff
-is a member of a family of related
+is also a name for an extended dialect of the
.I roff
-languages that share many traits.
+language.
.
We use \[lq]roff\[rq] to denote features that are universal,
or nearly so,
@@ -553,8 +553,9 @@ next defined tab stop.
.SH "Line continuation"
.\" ====================================================================
.
+The
.I roff
-languages distinguish input and output line continuation.
+language distinguishes input and output line continuation.
.
.
.P
@@ -999,8 +1000,9 @@ and
.
.
.P
+The
.I roff
-languages have no operator precedence:
+language has no operator precedence:
expressions are evaluated strictly from left to right,
in contrast to schoolhouse arithmetic.
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 03/13: [docs]: Speak in terms of "the roff language".,
G. Branden Robinson <=