groff
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [groff] mom manpage


From: G. Branden Robinson
Subject: Re: [groff] mom manpage
Date: Sat, 8 Dec 2018 14:04:33 -0500
User-agent: NeoMutt/20180716

At 2018-12-08T18:58:01+0100, Bertrand Garrigues wrote:
> >  * How do i know what to insert for <docdir>?
> [...]
> 
> In the main groff(1) man page there is the 'POSITIONS FROM INSTALLATION'
> section that documents all the installation directories used by the
> groff package.  This man page is generated and therefore lists the
> directories that were effectively used by the groff build system on the
> current machine.  There is a little thing that I'll fix later (this
> section still mention an old Makefile.comm file that no longer exists).

You don't need to--I've already got a fix pending for that.

And several other man pages commits I've queued up since the freeze.

Let me know when it's okay to push them.

I'm attaching the fix to the "POSITIONS FROM INSTALLATION" section
(which I would like to rename--it's pretty awkward English), and below
please find a 'git log origin..HEAD' of my other pending changes.

commit 6c16b7044373143bdc9afb34e0218e3c54ab7ce0
Author: G. Branden Robinson <address@hidden>
Date:   Fri Dec 7 12:24:46 2018 -0500

    groff(1): Update "Availability" section.
    
    * Note read-only status of bug-groff list.
    * Make the prose read well with or without explicit URLs.
    * Update location of groff-commit list (gnu.org, not ffii.org).
    * Tighten wording.
    
    Signed-off-by: G. Branden Robinson <address@hidden>

commit 5925826174a5947c9a73700ae6febab405c168de
Author: G. Branden Robinson <address@hidden>
Date:   Fri Dec 7 12:03:01 2018 -0500

    groff(1): Recast installation directory material.
    
    Kill off outdated reference to Makefile.comm.
    
    Resync list with the variables in Makefile.am that we makevarescape.
    
    The list is now collated by the order of the Makefile variable
    expansions, which is pretty feeble (and totally opaque to the reader),
    but there doesn't seem to be a better sort order given that the items
    are under the control of the person running the configure script.
    
    Signed-off-by: G. Branden Robinson <address@hidden>

commit 7bff11c876395a6c171fc8c6f923a168bf0b1956
Author: G. Branden Robinson <address@hidden>
Date:   Fri Dec 7 12:02:14 2018 -0500

    groff(1): DESC files describe devices, not fonts.
    
    Signed-off-by: G. Branden Robinson <address@hidden>

commit 42d3484e985582d23803a8738785ac54fb137288
Author: G. Branden Robinson <address@hidden>
Date:   Fri Dec 7 11:31:19 2018 -0500

    man pages: Hyphenate phrasal adjectives.
    
    ...when they precede nouns.
    
    Signed-off-by: G. Branden Robinson <address@hidden>

commit f7bb282a96820a01c0a64d966cab198c0b2a05d9
Author: G. Branden Robinson <address@hidden>
Date:   Fri Dec 7 11:26:28 2018 -0500

    man pages: Escape hyphens in filenames.
    
    Signed-off-by: G. Branden Robinson <address@hidden>

commit 0bfeec7a11ab416135190484e89f0dc92b51cfe9
Author: G. Branden Robinson <address@hidden>
Date:   Fri Dec 7 11:17:00 2018 -0500

    groff_me(7): Prefix .TH release info with "groff".
    
    ...as all the other man pages do (well, except groff_mdoc(7)).
    
    Signed-off-by: G. Branden Robinson <address@hidden>

commit 4e4f8c17096522afa585aa986d1b1d1ff7ed4d0c
Author: G. Branden Robinson <address@hidden>
Date:   Sat Dec 1 02:18:32 2018 -0500

    man pages: Set filespecs in italics, not bold.
    
    contrib/pdfmark/pdfroff.1.man:
    man/groff.7.man:
    man/groff_diff.7.man:
    man/groff_font.5.man:
    man/groff_out.5.man:
    man/groff_tmac.5.man:
    src/devices/grodvi/grodvi.1.man:
    src/devices/grolbp/grolbp.1.man:
    src/devices/grolj4/grolj4.1.man:
    src/devices/gropdf/gropdf.1.man:
    src/devices/grops/grops.1.man:
    src/devices/grotty/grotty.1.man:
    src/devices/xditview/gxditview.1.man:
    src/preproc/eqn/eqn.1.man:
    src/preproc/grn/grn.1.man:
    src/preproc/pic/pic.1.man:
    src/preproc/refer/refer.1.man:
    src/roff/groff/groff.1.man:
    src/roff/troff/troff.1.man:
    src/utils/indxbib/indxbib.1.man:
    src/utils/tfmtodit/tfmtodit.1.man:
    tmac/groff_ms.7.man:
    tmac/groff_www.7.man:
    + As above.
    
    contrib/pdfmark/pdfroff.1.man:
    man/groff_font.5.man:
    man/groff_out.5.man:
    man/groff_tmac.5.man:
    src/devices/grodvi/grodvi.1.man:
    src/devices/grohtml/grohtml.1.man:
    src/devices/grolbp/grolbp.1.man:
    src/devices/grolj4/grolj4.1.man:
    src/devices/gropdf/gropdf.1.man:
    src/devices/grops/grops.1.man:
    src/devices/grotty/grotty.1.man:
    src/devices/xditview/gxditview.1.man:
    src/preproc/grn/grn.1.man:
    src/preproc/refer/refer.1.man:
    src/roff/groff/groff.1.man:
    src/roff/troff/troff.1.man:
    src/utils/indxbib/indxbib.1.man:
    src/utils/tfmtodit/tfmtodit.1.man:
    + Set variable parts of filespecs in roman in filespec context but in
      italics when isolated in running prose; see groff_man(7).
    
    contrib/pdfmark/pdfroff.1.man:
    + Set shell variable expansions within filespecs in roman.
    + Stop suppressing hyphenation before macro-expanded filespecs.  Since
      commit ea32b7d0462813fc3e7c423efb6d805273df9edd, we get free
      discretionary breaks after slashes in macro-expanded filespec
      components anyway.  So with any luck, even in the unlikely case a
      filespec paragraph tag has to be broken, it won't be done in an
      eye-watering place using a hyphen.
    
    man/groff_out.5.man:
    + Remove pseudo-prefix from src/libs/libdriver/input.cpp.  The
      subsequent paragraph already describes it as being relative to the top
      of the groff source tree.  I think this is an abuse of the Files
      section (and this is section 5--files don't open files), but doing
      something about that is out of scope for this changeset.
    
    man/groff_tmac.5.man:
    + Use font macros rather than font escapes; also eliminates use of
      italic-correction escapes.
    
    src/devices/gropdf/gropdf.1.man:
    src/devices/grops/grops.1.man:
    + Don't quote filespecs on top of or instead of italicizing them.
    
    src/devices/grotty/grotty.1.man:
    + Delete word "kludgy" from the description of the alternate character
      definitions in tty-char.tmac; Ingo Schwarze has spent some effort
      improving them.
    
    Signed-off-by: G. Branden Robinson <address@hidden>

commit b6f2d91a086df59accb5d91e89bf65165a21fe3a
Author: G. Branden Robinson <address@hidden>
Date:   Fri Nov 30 23:12:51 2018 -0500

    *.man: Regularize (sub)section cross references.
    
    contrib/gdiffmk/gdiffmk.1.man:
    contrib/groffer/groffer.1.man:
    contrib/mm/groff_mm.7.man:
    contrib/pdfmark/pdfroff.1.man:
    man/groff.7.man:
    man/groff_diff.7.man:
    man/groff_out.5.man:
    man/groff_tmac.5.man:
    man/roff.7.man:
    src/devices/grolbp/grolbp.1.man:
    src/devices/gropdf/gropdf.1.man:
    src/devices/grops/grops.1.man:
    src/preproc/eqn/eqn.1.man:
    src/preproc/refer/refer.1.man:
    src/roff/troff/troff.1.man:
    tmac/groff_ms.7.man:
    + Quote (sub)section names instead of setting them in bold or italics.
    
    contrib/mm/groff_mm.7.man:
    contrib/pdfmark/pdfroff.1.man:
    man/groff.7.man:
    man/groff_out.5.man:
    man/groff_tmac.5.man:
    man/roff.7.man:
    src/devices/grolbp/grolbp.1.man:
    src/devices/gropdf/gropdf.1.man:
    src/devices/grops/grops.1.man:
    src/preproc/eqn/eqn.1.man:
    src/preproc/refer/refer.1.man:
    + When cross referencing a local (sub)section, add direction of
      reference ("above" vs. "below").
    
    contrib/mm/groff_mm.7.man:
    contrib/pdfmark/pdfroff.1.man:
    man/groff.7.man:
    man/groff_diff.7.man:
    man/groff_out.5.man:
    man/groff_tmac.5.man:
    man/roff.7.man:
    src/devices/grolbp/grolbp.1.man:
    src/devices/gropdf/gropdf.1.man:
    src/devices/grops/grops.1.man:
    src/preproc/eqn/eqn.1.man:
    src/roff/troff/troff.1.man:
    tmac/groff_man.7.man:
    + Stop setting (sub)section names in all caps.  That is a presentational
      matter better decided in the implementation of the .SH and .SS macros.
    
    contrib/groffer/groffer.1.man:
    + Fix comma splice.
    + Fix incorrect (or outdated) section name reference to X(7).
    
    contrib/mm/groff_mm.7.man:
    + "See also" is a good section title, but in prose, "also see" is more
      idiomatic.
    
    man/groff_char.7.man:
    + "{next,previous} section" get a definite article.
    
    man/groff_diff.7.man:
    src/devices/grolbp/grolbp.1.man:
    tmac/groff_man.7.man:
    + (Sub)section $IDENTIFIER by contrast does _not_ require a definite
      article.
    
    man/groff_out.5.man:
    + Fix incorrect reference (named section is actually a subsection).
    
    man/groff_tmac.5.man:
    + Fix non-idiomatic English "some" -> "a".  My favorite example of this
      is an old Debian package description of a Moon Patrol clone:
        "drive some car across the moon"
      ...which carries a pointed tone of contempt or ambivalence to a
      native speaker.
    
    src/devices/gropdf/gropdf.1.man:
    src/devices/grops/grops.1.man:
    + There is no need to identify the destination of a cross reference as a
      man page if it's formatted as only man page references are ("foo(1)").

commit 697d6978f2750103a95d17f43ceec9312f7b174a
Author: G. Branden Robinson <address@hidden>
Date:   Fri Nov 30 20:15:40 2018 -0500

    NEWS, man pages: Fix typos.
    
    ...the sort a spell checker doesn't catch.
    
    Signed-off-by: G. Branden Robinson <address@hidden>

Regards,
Branden

Attachment: positions.diff
Description: Text Data

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]