Regression in WoMan

Regression in WoMan

[Sven Joachim]

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

Running WoMan on the attached file reveals a regression in
EMACS_22_BASE: press TAB and the cursor jumps to the "#include
<stdlib.h>" after the SYNOPSIS, press TAB again and it stays there.

In Emacs 22.1, pressing TAB twice jumps to the "atof(3)" after the SEE
ALSO near the end, further TABs cycle through the references.

In GNU Emacs 22.1.50.1 (i486-pc-linux-gnu, GTK+ Version 2.12.3)
 of 2008-01-05 on debian, modified by Debian
Windowing system distributor `The X.Org Foundation', version 11.0.10300000
configured using `configure  '--build' 'i486-linux-gnu' '--host' 'i486-linux-gnu' '--prefix=/usr' '--sharedstatedir=/var/lib' '--libexecdir=/usr/lib' '--localstatedir=/var' '--infodir=/usr/share/info' '--mandir=/usr/share/man' '--with-pop=yes' '--enable-locallisppath=/etc/emacs-snapshot:/etc/emacs:/usr/local/share/emacs/22.1.50/site-lisp:/usr/local/share/emacs/site-lisp:/usr/share/emacs/22.1.50/site-lisp:/usr/share/emacs/site-lisp:/usr/share/emacs/22.1.50/leim' '--with-x=yes' '--with-x-toolkit=gtk' 'build_alias=i486-linux-gnu' 'host_alias=i486-linux-gnu' 'CFLAGS=-DDEBIAN -DSITELOAD_PURESIZE_EXTRA=5000 -g -O2''

Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: C
  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: de_DE.UTF-8
  locale-coding-system: utf-8
  default-enable-multibyte-characters: t

Major mode: WoMan

Minor modes in effect:
  shell-dirtrack-mode: t
  display-time-mode: t
  auto-image-file-mode: t
  show-paren-mode: t
  tooltip-mode: t
  mouse-wheel-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  unify-8859-on-encoding-mode: t
  utf-translate-cjk-mode: t
  auto-compression-mode: t
  temp-buffer-resize-mode: t
  column-number-mode: t
  line-number-mode: t
  transient-mark-mode: t

Recent input:
<up> <up> <up> <up> <up> <up> <up> <up> <down> SPC 
SPC SPC q g SPC SPC n n n q g <up> <up> <up> <up> <up> 
SPC q <up> <down> <return> d SPC n <down> SPC <down> 
SPC <down> SPC <down> SPC <down> SPC <down> SPC <down> 
SPC q g SPC <down> SPC <down> SPC <down> SPC q g C-x 
b m b <tab> <return> <return> <C-end> C-x r b t r <tab> 
<return> C-x h M-w C-x b <return> C-y C-u C-SPC <down> 
<f12> C-x C-s <f4> <return> y n y n y n n C-u C-SPC 
C-x C-s <next> <next> <next> <next> <next> <next> <next> 
C-x k <return> C-x k <return> g <switch-frame> C-x 
b <return> g <up> <up> <up> <up> <up> <up> SPC q <down> 
<down> <down> <down> <down> SPC q SPC <down> SPC q 
SPC <up> d q SPC q SPC SPC q <up> <up> <up> <up> <up> 
<up> <up> <up> <up> SPC <down> SPC q <up> <up> <up> 
<up> SPC SPC SPC <down> SPC <down> SPC <down> <up> 
q SPC <down> SPC <down> SPC <down> SPC SPC <down> SPC 
<down> SPC q g <up> <up> <up> SPC SPC q C-x b <return> 
<return> <C-end> C-x r b t r <tab> <return> C-x h M-w 
C-x b <return> C-y C-u C-SPC <down> <f12> C-x C-s <f4> 
<return> y y n y n y n n y n n n q C-u C-SPC C-x C-s 
<next> <next> <next> <next> <next> <f4> <return> n 
y n C-u C-SPC C-x C-s <next> <next> <next> C-x k <return> 
C-x k <return> g <C-f1> s t r <tab> t o <tab> l <tab> 
<return> <tab> <tab> <next> <next> <tab> <tab> <next> 
<C-home> <tab> <tab> M-x r e p o <tab> r t <tab> e 
m <tab> b u g <tab> <return>

Recent messages:
Mark set
call-interactively: End of buffer
Making completion list... [2 times]
uncompressing strtol.3.gz...done
WoMan formatting buffer...done in 0 seconds
mouse-2: display this header file [4 times]
Mark set
mouse-2: display this header file [2 times]
Making completion list...
Loading emacsbug...done


[-- Attachment #2: strtol.3.gz --]
[-- Type: application/octet-stream, Size: 3075 bytes --]

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel

Re: Regression in WoMan

[Juri Linkov]

> Running WoMan on the attached file reveals a regression in
> EMACS_22_BASE: press TAB and the cursor jumps to the "#include
> <stdlib.h>" after the SYNOPSIS, press TAB again and it stays there.
>
> In Emacs 22.1, pressing TAB twice jumps to the "atof(3)" after the SEE
> ALSO near the end, further TABs cycle through the references.

This is caused by the 2007-06-04 change in man.el (Man-next-section)
discussed in
http://lists.gnu.org/archive/html/emacs-devel/2007-05/msg00243.html
that ignores the last line of the man page as not belonging to
any section.  Your file doesn't contain the last line in the format that
contains the name of the current man page and a timestamp, so the last
section "SEE ALSO" gets ignored by Man-highlight-references.

It seems there was an invalid assumption that the last line should be
ignored unconditionally.  Maybe some additional check should take care
that the last line in the standard format (I can't find where it is
documented).

-- 
Juri Linkov http://www.jurta.org/emacs/

Re: Regression in WoMan

[Sven Joachim]

On 2008-01-07 00:11 +0100, Juri Linkov wrote:

>> Running WoMan on the attached file reveals a regression in
>> EMACS_22_BASE: press TAB and the cursor jumps to the "#include
>> <stdlib.h>" after the SYNOPSIS, press TAB again and it stays there.
>>
>> In Emacs 22.1, pressing TAB twice jumps to the "atof(3)" after the SEE
>> ALSO near the end, further TABs cycle through the references.
>
> This is caused by the 2007-06-04 change in man.el (Man-next-section)
> discussed in
> http://lists.gnu.org/archive/html/emacs-devel/2007-05/msg00243.html
> that ignores the last line of the man page as not belonging to
> any section.

I see.  The assumption that the last line always contains a footer seems
to be valid if the manpage is rendered by 'man', but 'woman' does not
insert such a footer (more precisely, it deliberately deletes the footer,
see the woman-man-buffer function).

>  Your file doesn't contain the last line in the format that
> contains the name of the current man page and a timestamp, so the last
> section "SEE ALSO" gets ignored by Man-highlight-references.
>
> It seems there was an invalid assumption that the last line should be
> ignored unconditionally.  Maybe some additional check should take care
> that the last line in the standard format (I can't find where it is
> documented).

There seem to be three possibilities to solve the issue: have woman
insert a footer like man does; differentiate the treatment of the last
line between man and woman ; or remove the footer in man buffers as
well.

What would be the best?

Sven

Re: Regression in WoMan

[Juri Linkov]

> There seem to be three possibilities to solve the issue: have woman
> insert a footer like man does; differentiate the treatment of the last
> line between man and woman ; or remove the footer in man buffers as
> well.
>
> What would be the best?

The fourth possibility is to use the same regexps used to remove
the footer by woman-man-buffer, to check the existence of the footer
before ignoring the last line in Man-next-section.

-- 
Juri Linkov
http://www.jurta.org/emacs/

Re: Regression in WoMan

[Sven Joachim]

On 2008-01-08 01:14 +0100, Juri Linkov wrote:

>> There seem to be three possibilities to solve the issue: have woman
>> insert a footer like man does; differentiate the treatment of the last
>> line between man and woman ; or remove the footer in man buffers as
>> well.
>>
>> What would be the best?
>
> The fourth possibility is to use the same regexps used to remove
> the footer by woman-man-buffer, to check the existence of the footer
> before ignoring the last line in Man-next-section.

I looked at this possibility, but it does not seem to work;
woman-man-buffer assumes that nroff inserts page numbers at the end of
the line, but that's not the case with modern nroff (depending on the
output device, I assume).  For instance, the getch manpage only displays
"getch(3NCURSES)" as non-space characters in the footer line.  How are
we going to detect that this is a footer?