bugGNU roff - Bugs: bug #59222, Issues with groff man pages

 
 

bug #59222: Issues with groff man pages

Submitter:  Helge Kreutzmann <kreutzm>
Submitted:  Sun 04 Oct 2020 12:41:24 PM UTC
   
 
Category:  General Severity:  3 - Normal
Item Group:  Documentation Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.23.0
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 08 Oct 2020 11:58:59 AM UTC, comment #1: 

Thanks for the report, Helge.

original submission:

> Man page: groff.1
> Issue: Why B<and> but not B<7>?
>
> "I<groff> has man pages in sections B<1>,B< 5>,B<and> 7B<.>"
> --
> Man page: groff.1
> Issue: English sentence broken (and sentence garbage: »in the same section« and »with the lowset section«)
>
> "When there are several I<man pages> with the same name in the same I<man> "
> "section, the one with the lowest section is should as first."
> --


The above 2 issues were both resolved through elimination of the material.


commit 550ab5338e04e54539214997315f451c89ac25e6
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Sep 14 21:10:15 2020 +1000

    man pages: Remove unncessary material.

[...]

    * src/roff/groff/groff.1.man: Remove novice-oriented material
      introducing the concept of man page section numbers and man(1) usage
      advice.  This is not appropriate here; intro(1) is the proper place.


> Man page: soelim.1
> Issue: missing whitespace
>
> "B<-I>I<dir>"


This one has just been fixed alongside a bunch of other changes to the page.


commit 7eca9c3c6d0efdbb29dcedad51d18d4c4993a22a (HEAD -> master, origin/master, origin/HEAD)
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Oct 8 22:11:38 2020 +1100

    soelim(1): Fix style problems.

    * Update apropos summary.  Expand ".so" request to its mnemonic
      (source), and characterize input as "troff" instead of "groff" since,
      in contrast to some GNU roff preprocessors, GNU soelim should work
      fine for traditional troff input.
    * Define and use string for rendering the TeX logo correctly on
      typesetter devices, like other groff man pages.
    * Stop using .OP macro in favor of font macros.  Also place explicit
      space between option flag and its argument.
    * Rename "file" parameter to "input-file" for disambiguation.
    * Recast description to clearly distinguish arguments to soelim from
      arguments to .so requests in the processed input.
    * Note that soelim works recursively.
    * Note how soelim treats standard input and output.
    * Use font changes as well as quotation marks to clarify discussion of
      escape sequences recognized by soelim.
    * Call out "\[rs]" as _not_ recognized.
    * Remove unneeded "Note that" construction (here's to you, Dave Kemper).
    * Set command names in italics.
    * Use command prefix consistently; it was neglected in places.
    * The command prefix creates pain for the diagrams used in this man
      page; if there is a command prefix, add language noting the different
      usage in the diagram, guarded by an .if request.  Put a dollar in the
      man page swear jar.  Add comment explaining what's going on.
    * Replace .nf and .fi requests with .EX and .EE macros.
    * Use arrow and bracket-building glyphs instead of ASCII art for arrows
      in terminal versions of diagrams.
    * Recast description of -I option in imperative mood.  Also place
      explicit space between option flag and its argument.
    * Break input lines after commas and semicolons.
    * Put parenthetical asides on their own input lines.


G. Branden Robinson <gbranden>
Group administrator
Sun 04 Oct 2020 12:41:24 PM UTC, original submission:  

Dear groff maintainer,
the manpage-l10n project maintains a large number of translations of
man pages both from a large variety of sources (including groff) as
well for a large variety of target languages.

During their work translators notice different possible issues in the
original (english) man pages. Sometimes this is a straightforward
typo, sometimes a hard to read sentence, sometimes this is a
convention not held up and sometimes we simply do not understand the
original.

We use several distributions as sources and update regularly (at
least every 2 month). This means we are fairly recent (some
distributions like archlinux also update frequently) but might miss
the latest upstream version once in a while, so the error might be
already fixed. We apologize and ask you to close the issue immediately
if this should be the case, but given the huge volume of projects and
the very limited number of volunteers we are not able to double check
each and every issue.

Secondly we translators see the manpages in the neutral po format,
i.e. converted and harmonized, but not the original source (be it man,
groff, xml or other). So we cannot provide a true patch (where
possible), but only an approximation which you need to convert into
your source format.

Finally the issues I'm reporting have accumulated over time and are
not always discovered by me, so sometimes my description of the
problem my be a bit limited - do not hesitate to ask so we can clarify
them.

I'm now reporting the errors for your project. If future reports
should use another channel, please let me know.

Man page: groff.1
Issue: Why B<and> but not B<7>?

"I<groff> has man pages in sections B<1>,B< 5>,B<and> 7B<.>"
--
Man page: groff.1
Issue: English sentence broken (and sentence garbage: »in the same section« and »with the lowset section«)

"When there are several I<man pages> with the same name in the same I<man> "
"section, the one with the lowest section is should as first."
--
Man page: soelim.1
Issue: missing whitespace

"B<-I>I<dir>"

Helge Kreutzmann <kreutzm>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (Posted a comment)
  • -email is unavailable- added by kreutzm (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 6 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-06-15 gbranden CategoryNone General
    2020-10-08 gbranden Item GroupNone Documentation
        StatusNone Fixed
        Assigned toNone gbranden
        Open/ClosedOpen Closed
        Planned ReleaseNone 1.23.0

    Back to the top

    Powered by Savane 3.13-3230.
    Corresponding source code