gbranden pushed a commit to branch master
in repository groff.
commit c40bad94772f5a0cfd090191cc6c429a3ca22628
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Dec 20 23:02:00 2025 -0600
[doc,man]: Revise and resync aln, als req descs.
* In our Texinfo manual, kick warning stuff into footnotes.
* Sync wording between our Texinfo manual and man pages.
* Fix incorrect man page cross references.
---
doc/groff.texi.in | 20 ++++++++------------
man/groff.7.man | 21 ++++++++++++++++-----
man/groff_diff.7.man | 15 ++++++++-------
3 files changed, 32 insertions(+), 24 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 976d1bee0..d65504807 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -8463,13 +8463,11 @@ causing the names to refer to the same stored object.
If
@var{existing-register}
is undefined,
-GNU
+the formatter ignores the request.@footnote{GNU
@command{troff} @c GNU
-produces a warning in category
-@samp{reg}
-and ignores the request.
-@xref{Warnings},
-regarding the enablement and suppression of warnings.
+emits a warning in category
+@samp{reg}.
+@xref{Warnings}.}
@cindex alias, register, removing (@code{rr})
@cindex removing alias of register (@code{rr})
@@ -14582,17 +14580,15 @@ causing the names to refer to the same stored object.
If
@var{existing-name}
is undefined,
-GNU
+the formatter ignores the request.@footnote{GNU
@command{troff} @c GNU
-produces a warning in category
-@samp{mac}
-and ignores the request.
+emits a warning in category
+@samp{mac}.
+@xref{Warnings}.}
If
@var{new-name}
already exists,
its contents are lost unless already aliased.
-@xref{Warnings},
-regarding the enablement and suppression of warnings.
To understand how the @code{als} request works, consider two different
storage pools:@: one for objects (macros, strings, etc.), and another
diff --git a/man/groff.7.man b/man/groff.7.man
index 39f3ca3fd..fec568e0d 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -2748,7 +2748,17 @@ Create alias
(additional name)
.I new-register
of
-.IR existing-register .
+.IR existing-register ,
+causing the names to refer to the same stored object.
+.
+If
+.I existing-register
+is undefined,
+the formatter ignores the request.
+GNU
+.I troff \" GNU
+emits a warning in category
+.RB \[lq] reg \[rq].
.
.TPx
.REQ .als "new-name existing-name"
@@ -2759,16 +2769,17 @@ of request,
string,
macro,
or diversion
-.IR existing-name .
+.IR existing-name ,
+causing the names to refer to the same stored object.
.
If
.I existing-name
is undefined,
+the formatter ignores the request.
GNU
.I troff \" GNU
-produces a warning in category
-.RB \[lq] mac \[rq]
-and ignores the request.
+emits a warning in category
+.RB \[lq] mac \[rq].
.
If
.I new-name
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 9dba44aec..8e8c68f95 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -1948,19 +1948,20 @@ Create alias
(additional name)
.I new-register
of
-.IR existing-register .
+.IR existing-register ,
+causing the names to refer to the same stored object.
.
If
.I existing-register
is undefined,
+the formatter ignores the request.
GNU
.I troff \" GNU
produces a warning in category
-.RB \[lq] reg \[rq]
-and ignores the request.
+.RB \[lq] reg \[rq].
.
See section \[lq]Warnings\[rq] of
-.MR @g@groff 1
+.MR @g@troff 1
regarding the enablement and suppression of warnings.
.
To remove a register alias,
@@ -1987,11 +1988,11 @@ causing the names to refer to the same stored object.
If
.I existing-name
is undefined,
+the formatter ignores the request.
GNU
.I troff \" GNU
produces a warning in category
-.RB \[lq] mac \[rq]
-and ignores the request.
+.RB \[lq] mac \[rq].
.
If
.I new-name
@@ -1999,7 +2000,7 @@ already exists,
its contents are lost unless already aliased.
.
See section \[lq]Warnings\[rq] of
-.MR @g@groff 1
+.MR @g@troff 1
regarding the enablement and suppression of warnings.
.
To remove an alias,
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
