bug#7843: 24.0.50; woman leaves \& in man page header

bug#7843: 24.0.50; woman leaves \& in man page header

[Eric Hanchrow]

I typed

M-x w o m a n <return> g i t - r e m o t e <return>

and saw the man page for the "git-remote" command.

At the top of that page, I saw

        GIT-REMOTE(1) -- 10/30/2010 -- Git 1\&.7\&.3\&.2 -- Git Manual

The \& in the third section are bogus; "M-x man git-remote" correctly
omits them.
In GNU Emacs 24.0.50.1 (i686-pc-linux-gnu)
 of 2011-01-10 on erich-laptop
Windowing system distributor `The X.Org Foundation', version 11.0.10900000
configured using `configure  '--with-x-toolkit=no''

Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en_US.utf8
  value of $XMODIFIERS: nil
  locale-coding-system: utf-8-unix
  default enable-multibyte-characters: t

Major mode: Emacs-Lisp

Minor modes in effect:
  shell-dirtrack-mode: t
  eldoc-mode: t
  diff-auto-refine-mode: t
  global-auto-revert-mode: t
  ido-everywhere: t
  display-time-mode: t
  tooltip-mode: t
  mouse-wheel-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t

Recent input:
M-> C-c C-c M-p C-a C-d C-d C-d C-d L O G M-> <return>
C-0 M-> C-c C-c M-p C-a M-d M-d f a k e r o o t <return>
C-c C-c C-x b s e t <return> C-x b s c r <return> C-x
8 t C-SPC C-a M-w C-x b s h e <return> c d SPC / u
s r / l o c <tab> s r <tab> e m <tab> g <tab> <return>
c d SPC e m <tab> <return> g i t SPC r e m o t e SPC
u p d a t e <return> M-x w o m a n <return> g i t -
r e m o t e <return> l <return> <return> C-s u p d
a t e C-s C-a C-u M-x w o m a n <return> g i t - r
e b a s <tab> <return> q M-x w <backspace> m a n <return>
g i t - <tab> r <tab> e <tab> m <tab> <return> C-x
o M-> C-x o M-< C-x 1 C-x b s h e <return> l o c a
t e SPC g i t - r e m o t e . 1 <return> M-p S-SPC
\ SPC x a <backspace> <backspace> <backspace> <backspace>
| SPC x a r g s SPC l s SPC - l L <return> C-p C-x
C-f <return> C-x F w o m a n <return> C-M-s \ b t h
\ b C-s C-s C-s C-x n d C-x 2 C-x b <return> C-x 0
C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n C-n
C-n C-n C-n C-n C-n C-n C-n C-n C-n C-x n w M-x r e
p o r t - e m <tab> <return>

Recent messages:
Mark saved where search started
Building list of manual directory expansions...
Building completion list of all manual topics...
WoMan formatting buffer...done in 0 seconds
Invoking man git-remote in the background
Please wait: formatting the git-remote man page...
git-remote man page formatted
Mark set [2 times]
History item: 1
Mark saved where search started

Load-path shadows:
~/.emacs.d/custom hides /usr/local/src/emacs-git/master/lisp/custom

Features:
(shadow mail-extr message sendmail rfc822 mml mml-sec mm-decode
mm-bodies mm-encode mail-parse rfc2231 rfc2047 rfc2045 ietf-drums
mm-util mail-prsvr mailabbrev mail-utils gmm-utils mailheader emacsbug
nroff-mode iso-transl face-remap sql align tabify ediff-merg ediff-diff
ediff-wind ediff-help ediff-util ediff-mult ediff-init ediff pcomplete
warnings texinfo compare-w ruby-mode epa-file paste-to-dropbox conf-mode
skeleton sh-script executable disp-table nxml-uchnm rng-xsd xsd-regexp
rng-cmpct rng-nxml rng-valid rng-loc rng-uri rng-parse nxml-parse
rng-match rng-dt rng-util rng-pttrn nxml-ns nxml-mode nxml-outln
nxml-rap nxml-util nxml-glyph nxml-enc xmltok sgml-mode thingatpt
geiser-mode geiser-xref geiser-compile geiser-debug geiser-racket
geiser-guile geiser-repl geiser-doc geiser-menu geiser-company
geiser-autodoc info-look info geiser-edit etags geiser-completion
geiser-eval geiser-connection tq geiser-syntax geiser-log geiser-popup
geiser-impl geiser-custom geiser-base geiser byte-opt bytecomp
byte-compile dabbrev find-dired sort jka-compr wdired scheme newcomment
ffap multi-isearch python-21 python log-view wid-edit help-mode view
tramp-cache tramp tramp-compat auth-source netrc gnus-util
password-cache format-spec tramp-loaddefs smerge-mode vc-bzr sha1
hex-util vc-sccs vc-svn vc-cvs vc-rcs vc-dir ewoc vc vc-dispatcher shell
js2-mode-autoloads swank-clojure-autoloads clojure-mode-autoloads
slime-repl-autoloads slime-autoloads package woman man eldoc midnight
uniquify advice help-fns advice-preload epa epg epg-config magit
diff-mode log-edit easymenu easy-mmode pcvs-util add-log magit-key-mode
assoc vc-git derived autorevert ansi-color server grep compile comint
ring cl find-func ibuf-ext ibuf-macs ibuffer ido dired-x dired-aux dired
regexp-opt edmacro kmacro rx autoinsert time tooltip ediff-hook vc-hooks
lisp-float-type mwheel x-win x-dnd tool-bar dnd fontset image fringe
lisp-mode register page menu-bar rfn-eshadow timer select scroll-bar
mouse jit-lock font-lock syntax facemenu font-core frame cham georgian
utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao korean
japanese hebrew greek romanian slovak czech european ethiopic indian
cyrillic chinese case-table epa-hook jka-cmpr-hook help simple abbrev
loaddefs button minibuffer faces cus-face files text-properties overlay
md5 base64 format env code-pages mule custom widget
hashtable-print-readable backquote make-network-process dbusbind
dynamic-setting font-render-setting x multi-tty emacs)

bug#7843: 24.0.50; woman leaves \& in man page header

[Chong Yidong]

Eric Hanchrow <eric.hanchrow@gmail.com> writes:

> M-x w o m a n <return> g i t - r e m o t e <return>
>
> and saw the man page for the "git-remote" command.
>
> At the top of that page, I saw
>
>         GIT-REMOTE(1) -- 10/30/2010 -- Git 1\&.7\&.3\&.2 -- Git Manual
>
> The \& in the third section are bogus; "M-x man git-remote" correctly
> omits them.

I've checked in what I think is a correct fix into the trunk.

(I'm hardly an expert in this part of the code, so it's better not to
put it in the branch in case it turns out to be a wrong fix.)

bug#7843: 24.0.50; woman leaves \& in man page header

[Glenn Morris]

[-- Attachment #1: Type: text/plain, Size: 1037 bytes --]

Chong Yidong wrote:

> I've checked in what I think is a correct fix into the trunk.
>
> (I'm hardly an expert in this part of the code, so it's better not to
> put it in the branch in case it turns out to be a wrong fix.)

You jinxed it. ;)
It seems to cause problems. man.1 (attached) renders worse in the
current trunk than in Emacs 23.3. The woman-log buffer has many entries
that do not appear in 23.3:

**  Escape ignored: \- -> -
    [many times]
**  Escape ignored: \f -> f
    [many times]
**  ..  request ignored!
    [several times]
**  Numeric/register argument error: w'man 'u

An example of a section that renders worse is

   The following conventions apply  to the SYNOPSIS section and
   can be used as a guide in other sections.

   fBbold textfR@T{
   type exactly as shown.
   T}

In 23.3, "bold text" is correctly rendered in bold.

Also the spaces are missing between "man" and the arguments in the
following section:
   
   EXAMPLES
   
       man ls
           Display the manual page for the item (program) ls.


[-- Attachment #2: man.1.gz --]
[-- Type: application/octet-stream, Size: 12409 bytes --]

bug#7843: 24.0.50; woman leaves \& in man page header

[Eli Zaretskii]

> From: Glenn Morris <rgm@gnu.org>
> Date: Fri, 09 Sep 2011 03:07:57 -0400
> Cc: 7843@debbugs.gnu.org, Eric Hanchrow <eric.hanchrow@gmail.com>
> 
> It seems to cause problems. man.1 (attached) renders worse in the
> current trunk than in Emacs 23.3. The woman-log buffer has many entries
> that do not appear in 23.3:
> 
> **  Escape ignored: \- -> -
>     [many times]
> **  Escape ignored: \f -> f
>     [many times]
> **  ..  request ignored!
>     [several times]
> **  Numeric/register argument error: w'man 'u

My version of Groff (1.19) also emits quite a bit of diagnostics for
that man page.

> An example of a section that renders worse is
> 
>    The following conventions apply  to the SYNOPSIS section and
>    can be used as a guide in other sections.
> 
>    fBbold textfR@T{
>    type exactly as shown.
>    T}

So does Groff (invoked by my clone of `man'):

 Reformatting page.  Wait...tbl:/usr/man/man1/man.1:182: unrecognised format `1'
 tbl:/usr/man/man1/man.1:182: giving up on this table
 tbl:/usr/man/man1/man.1:243: unrecognised format `\'
 tbl:/usr/man/man1/man.1:243: giving up on this table

bug#7843: 24.0.50; woman leaves \& in man page header

[Andreas Schwab]

Eli Zaretskii <eliz@gnu.org> writes:

> So does Groff (invoked by my clone of `man'):
>
>  Reformatting page.  Wait...tbl:/usr/man/man1/man.1:182: unrecognised format `1'
>  tbl:/usr/man/man1/man.1:182: giving up on this table
>  tbl:/usr/man/man1/man.1:243: unrecognised format `\'
>  tbl:/usr/man/man1/man.1:243: giving up on this table

tbl 1.21 has no problem with that.

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."

bug#7843: 24.0.50; woman leaves \& in man page header

[Eli Zaretskii]

> From: Andreas Schwab <schwab@linux-m68k.org>
> Cc: Glenn Morris <rgm@gnu.org>,  cyd@stupidchicken.com,  7843@debbugs.gnu.org,  eric.hanchrow@gmail.com
> Date: Fri, 09 Sep 2011 09:53:52 +0200
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> > So does Groff (invoked by my clone of `man'):
> >
> >  Reformatting page.  Wait...tbl:/usr/man/man1/man.1:182: unrecognised format `1'
> >  tbl:/usr/man/man1/man.1:182: giving up on this table
> >  tbl:/usr/man/man1/man.1:243: unrecognised format `\'
> >  tbl:/usr/man/man1/man.1:243: giving up on this table
> 
> tbl 1.21 has no problem with that.

I'm sure it doesn't.  I was just saying that bitrot is not limited to
woman.el.

bug#7843: 24.0.50; woman leaves \& in man page header

[Chong Yidong]

Glenn Morris <rgm@gnu.org> writes:

> Chong Yidong wrote:
>
>> I've checked in what I think is a correct fix into the trunk.
>>
>> (I'm hardly an expert in this part of the code, so it's better not to
>> put it in the branch in case it turns out to be a wrong fix.)
>
> You jinxed it. ;)
> It seems to cause problems. man.1 (attached) renders worse in the
> current trunk than in Emacs 23.3. The woman-log buffer has many entries
> that do not appear in 23.3:

OK, I checked in a fix.