[Groff-commit] groff ChangeLog doc/groff.texinfo

[Werner LEMBERG]

CVSROOT:        /cvsroot/groff
Module name:    groff
Changes by:     Werner LEMBERG <wl>     13/02/16 08:39:31

Modified files:
        .              : ChangeLog 
        doc            : groff.texinfo 

Log message:
        * doc/groff.texinfo: Improve documentation of `.substring'.
        
        Reported by Jim Avera <address@hidden>.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/groff/ChangeLog?cvsroot=groff&r1=1.1394&r2=1.1395
http://cvs.savannah.gnu.org/viewcvs/groff/doc/groff.texinfo?cvsroot=groff&r1=1.317&r2=1.318

Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/groff/groff/ChangeLog,v
retrieving revision 1.1394
retrieving revision 1.1395
diff -u -b -r1.1394 -r1.1395
--- ChangeLog   13 Feb 2013 18:41:45 -0000      1.1394
+++ ChangeLog   16 Feb 2013 08:39:31 -0000      1.1395
@@ -1,3 +1,9 @@
+2013-02-16  Werner LEMBERG  <address@hidden>
+
+       * doc/groff.texinfo: Improve documentation of `.substring'.
+
+       Reported by Jim Avera <address@hidden>.
+
 2013-02-13  Werner LEMBERG  <address@hidden>
 
        * doc/groff.texinfo: Fix if-else example.

Index: doc/groff.texinfo
===================================================================
RCS file: /cvsroot/groff/groff/doc/groff.texinfo,v
retrieving revision 1.317
retrieving revision 1.318
diff -u -b -r1.317 -r1.318
--- doc/groff.texinfo   13 Feb 2013 18:41:45 -0000      1.317
+++ doc/groff.texinfo   16 Feb 2013 08:39:31 -0000      1.318
@@ -10811,18 +10811,21 @@
 @Defreq {substring, str n1 address@hidden
 @cindex substring (@code{substring})
 Replace the string named @var{str} with the substring defined by the
-indices @var{n1} address@hidden@var{n2}.  The first character in the string
-has address@hidden  If @var{n2} is omitted, it is taken to be equal to
-the string's length.  If the index value @var{n1} or @var{n2} is
-negative, it is counted from the end of the string, going backwards: The
-last character has address@hidden@minus{}1, the character before the last
-character has address@hidden@minus{}2, etc.
+indices @var{n1} and @var{n2}.  The first character in the string has
address@hidden  If @var{n2} is omitted, it is implicitly set to the
+largest valid value (the string length minus one).  If the index value
address@hidden or @var{n2} is negative, it is counted from the end of the
+string, going backwards: The last character has address@hidden@minus{}1,
+the character before the last character has address@hidden@minus{}2, etc.
 
 @Example
 .ds xxx abcdefgh
 .substring xxx 1 -4
 \*[xxx]
     @result{} bcde
+.substring xxx 2
+\*[xxx]
+    @result{} de
 @endExample
 @endDefreq