groff-commit
[Top][All Lists]
Advanced

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

[groff] 01/09: doc/groff.texi (Parameters): Fix error in example.


From: G. Branden Robinson
Subject: [groff] 01/09: doc/groff.texi (Parameters): Fix error in example.
Date: Sat, 28 Nov 2020 21:10:40 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 9b0a63a82c52832b05753f1469491de0afef6593
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Nov 28 23:13:51 2020 +1100

    doc/groff.texi (Parameters): Fix error in example.
    
    Arguments to .als were in the wrong order (.als is not ln(1)).  Also
    mark output to the standard error stream using the @error Texinfo
    command instead of @result.
    
    Problem dates back to 94aa325325dc02da6b1c09e31baca5e27013464a, 28
    September 2008.
    
    Thanks to Dorai Sitaram for finding this error.
    
    Fixes <https://savannah.gnu.org/bugs/?59566>.
---
 ChangeLog      | 11 +++++++++++
 doc/groff.texi | 10 +++++-----
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 6abe69e..2221c3a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,16 @@
 2020-11-28  G. Branden Robinson <g.branden.robinson@gmail.com>
 
+       * doc/groff.texi (Parameters): Fix error in example.  Arguments
+       to .als were in the wrong order (.als is not ln(1)).  Also mark
+       output to the standard error stream using the @error Texinfo
+       command instead of @result.
+
+       Thanks to Dorai Sitaram for finding this error.
+
+       Fixes <https://savannah.gnu.org/bugs/?59566>.
+
+2020-11-28  G. Branden Robinson <g.branden.robinson@gmail.com>
+
        * doc/groff.texi (Debugging): Update with a more helpful
        introduction, summarizing available procedures.  Mention
        backtracing since it is much more useful now (post-groff
diff --git a/doc/groff.texi b/doc/groff.texi
index c69bafc..1fe4106 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -12126,7 +12126,7 @@ If a macro is called as a string (within another 
macro), the value of
 .de foo
 .  tm \\$0
 ..
-.als foo bar
+.als bar foo
 .
 @endExample
 @Example
@@ -12146,13 +12146,13 @@ If a macro is called as a string (within another 
macro), the value of
 @endExample
 @Example
 .aaa
-    @result{} foo
+    @error{} foo
 .bbb
-    @result{} bar
+    @error{} bar
 .ccc
-    @result{} ccc
+    @error{} ccc
 .ddd
-    @result{} ddd
+    @error{} ddd
 @endExample
 @endDefesc
 



reply via email to

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