[groff] 01/01: Clarify meaning of \p escape.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 8ae30a9113a39c0280f3d831b7390c643e1a9072
Author: G. Branden Robinson <address@hidden>
Date:   Thu Oct 25 17:26:47 2018 -0400

    Clarify meaning of \p escape.
    
    Also make more explicit that line adjustment for the .brp request and \p
    escape depends on the current adjustment mode.
    
    * doc/groff.texi: Clarify that \p has effect at the next word
      boundary.  Thanks to Dave <barx> for pointing out the issue and
      providing elucidating language.
    
    * man/groff.7.man: Similar, but terser.
    
    Fixes https://savannah.gnu.org/bugs/index.php?54894.
    
    Also:
    
    * doc/groff.texi:
      + Fix subject/verb agreement: "TeX have" -> "TeX has".
      + Add Emacs fill-column to local variables.
      + Add Vim modeline.
    
    Signed-off-by: G. Branden Robinson <address@hidden>
---
 ChangeLog       | 14 ++++++++++++++
 doc/groff.texi  | 11 +++++++++--
 man/groff.7.man |  6 ++----
 3 files changed, 25 insertions(+), 6 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 487b564..5e2dea9 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2018-10-25  G. Branden Robinson <address@hidden>
+
+       Clarify meaning of \p escape.  Also make more explicit that line
+       adjustment for the .brp request and \p escape depends on the
+       current adjustment mode.
+
+       * doc/groff.texi: Clarify that \p has effect at the next word
+       boundary.  Thanks to Dave <barx> for pointing out the issue and
+       providing elucidating language.
+
+       * man/groff.7.man: Similar, but terser.
+
+       Fixes https://savannah.gnu.org/bugs/index.php?54894.
+
 2018-10-04  Deri James  <address@hidden>
 
        Savannah bug # 54812
diff --git a/doc/groff.texi b/doc/groff.texi
index f7de636..27a7b66 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -6838,11 +6838,16 @@ The adjustment mode status is associated with the 
current environment
 
 @DefreqList {brp, }
 @DefescListEndx {\\p, , , }
-Adjust the current line and cause a break.
+Break, adjusting the current line per the current adjustment mode.
+
+With @code{\p}, this break will happen at the next word boundary.  The
address@hidden itself is removed entirely, adding neither a break nor a space
+where it appears in input; it can thus be placed in the middle of a word
+to cause a break at the end of that word.
 
 In most cases this produces very ugly results since @code{gtroff}
 doesn't have a sophisticated paragraph building algorithm (as @TeX{}
-have, for example); instead, @code{gtroff} fills and adjusts a paragraph
+has, for example); instead, @code{gtroff} fills and adjusts a paragraph
 line by line:
 
 @Example
@@ -17237,4 +17242,6 @@ accessed as @samp{\[xxx]}.
 @c Local Variables:
 @c mode: texinfo
 @c coding: latin-1
address@hidden fill-column: 72
 @c End:
address@hidden vim: set textwidth=72:
diff --git a/man/groff.7.man b/man/groff.7.man
index f18bfc0..13b5272 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -1286,9 +1286,7 @@ Line break.
 .
 .TPx
 .REQ .brp
-Break and spread output line.
-Same as
-.esc p .
+Break output line; adjust if applicable.
 .
 .TPx
 .REQ .break
@@ -3223,7 +3221,7 @@ Mainly for internal use.
 .
 .TP
 .ESC p
-Break and spread output line.
+Break output line at next word boundary; adjust if applicable.
 .
 .TP
 .ESC r