groff-commit
[Top][All Lists]
Advanced

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

[groff] 28/35: [ms]: Clarify lack of support for some V7 macros.


From: G. Branden Robinson
Subject: [groff] 28/35: [ms]: Clarify lack of support for some V7 macros.
Date: Fri, 15 Jul 2022 23:12:00 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 02ca0869b5cd56ef61326e9f3ca47fedb6d591e2
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Jul 12 20:07:30 2022 -0500

    [ms]: Clarify lack of support for some V7 macros.
    
    * Advise users needing these macros to remove their definitions before
      redefining them, and explain why.
    * Fix a typo.
---
 doc/groff.texi      | 13 +++++++++----
 doc/ms.ms           | 16 +++++++++++++---
 tmac/groff_ms.7.man |  2 +-
 3 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index c45fa2ad..9f31c943 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -4529,7 +4529,7 @@ implementing several document type formats
 @code{MR}, @c memorandum for record
 @code{TM}, @c technical memorandum
 @code{TR}), @c technical report
-were meaningful only in conjuction with the use of certain document
+were meaningful only in conjunction with the use of certain document
 types
 (@code{AT}, @c attachments
 @code{CS}, @c cover sheet info for `TM` documents
@@ -4545,11 +4545,16 @@ stored the postal addresses of Bell Labs sites
 or lack a stable definition historically
 (@code{UX}). @c Unix; on 1st use, add footnote id'ing trademark owner
 To compatibly render historical @file{ms} documents using these macros,
-we advise you to define replacements with an authentically typeset
-original at hand.  For informal purposes, a simple definition of
-@code{UX} should maintain the readability of the document's substance.
+we advise your documents to invoke the @code{rm} request to remove any
+such macros it uses and then define replacements with an authentically
+typeset original at hand.@footnote{The removal beforehand is necessary
+because @code{groff} @file{ms} aliases these macros to a diagnostic
+macro, and you want to redefine the aliased name, not its target.}  For
+informal purposes, a simple definition of @code{UX} should maintain the
+readability of the document's substance.
 
 @CartoucheExample
+.rm UX
 .ds UX Unix\"
 @endCartoucheExample
 
diff --git a/doc/ms.ms b/doc/ms.ms
index 832bbfd8..02653c30 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -3832,7 +3832,7 @@ These include macros implementing several document type 
formats
 .CW MR , \" memorandum for record
 .CW TM , \" technical memorandum
 .CW TR ), \" technical report
-were meaningful only in conjuction with the use of certain document
+were meaningful only in conjunction with the use of certain document
 types
 (\c
 .CW AT , \" attachments
@@ -3854,8 +3854,17 @@ or lack a stable definition historically
 To compatibly render historical
 .I ms
 documents using these macros,
-we advise you to define replacements with an authentically typeset
-original at hand.
+we advise your documents to invoke the
+.CW rm
+request to remove any such macros it uses and then define replacements
+with an authentically typeset original at hand.\**
+.FS
+The removal beforehand is necessary because
+.I "groff ms"
+aliases these macros to a diagnostic macro,
+and you want to redefine the aliased name,
+not its target.
+.FE
 .
 For informal purposes,
 a simple definition of
@@ -3866,6 +3875,7 @@ should maintain the readability of the document's 
substance.
 .TS
 box center;
 lf(CR).
+\&.rm UX
 \&.ds UX Unix\[rs]"
 .TE
 .
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 20c8219f..7dd5c7a9 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -2582,7 +2582,7 @@ These include macros implementing several document type 
formats
 .BR MR , \" memorandum for record
 .BR TM , \" technical memorandum
 .BR TR ), \" technical report
-were meaningful only in conjuction with the use of certain document
+were meaningful only in conjunction with the use of certain document
 types
 (\c
 .BR AT , \" attachments



reply via email to

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