bugGNU troff - Bugs: bug #60789, [man] reclaim "-man"...

 
 

bug #60789: [man] reclaim "-man" "-m man" etc. arguments

Submitter:  G. Branden Robinson <gbranden>
Submitted:  Thu 17 Jun 2021 03:28:43 PM UTC
 
Category:  Macro man Severity:  1 - Wish
Item Group:  Build/Installation Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.23.0
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       No canned response available

 

Tue 06 Jul 2021 09:09:19 AM UTC, comment #1: 

commit 45e72d6bab9d46763885e7bf961af53230fe6597
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Tue Jul 6 18:10:48 2021 +1000

    [man]: Reflect rename in man pages.

    * man/groff_tmac.5.man (Macro packages/man pages):
    * src/roff/groff/groff.1.man (Usage/Macro packages): Update discussion
      of an, doc, and andoc.

    * tmac/groff_man.7.man.in (Files): Update descriptions of an.tmac,
      andoc.tmac, man.tmac, and mandoc.tmac.

commit 1180b353de18ad26ed2bbfb0a8a88ab565343f55
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Jul 5 23:35:01 2021 +1000

    [man]: Reflect rename in documentation.

    * PROBLEMS:
    * doc/groff.texi (man):
    * tmac/man.local: Update documentation appropriately.

    * NEWS: Add item.

    Fixes <https://savannah.gnu.org/bugs/?60789>.

commit 99b0e66bdb89ad6574e43192cb2a96b9754056b8
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Jul 5 23:05:54 2021 +1000

    tmac/an.tmac: Drop "-old" nomenclature.

commit fdac25937ff4a1c81366e0fedcf66271e105d7dd
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Jul 5 23:02:18 2021 +1000

    [mandoc]: Reflect man rename in package and test.

    * tmac/tmac.an (tmac/stamp-wrap): Macro-source `an.tmac` in the man
      wrapper.

    * tmac/andoc.tmac: Refer to (and macro-source) an.tmac.

    * tmac/man.tmac: Macro-source `an.tmac`, not `andoc.tmac`.

    * tmac/tests/andoc_flush-between-packages.sh: Call groff with `-mandoc`
      option instead of `-man`.  Henceforth, if you want the andoc wrapper,
      you have to ask for it.

commit 19b85e1ae1c74a5f8894bbd0f5ae05902c19c1a3
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Jul 5 22:57:25 2021 +1000

    [man]: Reflect renames in build.

    * tmac/tmac.am (TMACNORMALFILES): Remove an-old.tmac.
      (tmac_TESTS): Reflect renames of test files.

    WARNING: This commit fails an andoc test.
commit c1fd48aeb9a0545916341ae66d0734a6c990a406
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Jul 5 22:50:48 2021 +1000

    [man]: Rename implementation.

    * tmac/an-old.tmac: Rename...
    * tmac/an.tmac: ...to this.

    * tmac/tests/an-old_AT-and-UC-footer-saved-and-restored.sh:
    * tmac/tests/an-old_CS-register-off.sh:
    * tmac/tests/an-old_CS-register-on.sh:
    * tmac/tests/an-old_CS-register-unspecified.sh:
    * tmac/tests/an-old_CT-register-off.sh:
    * tmac/tests/an-old_CT-register-on.sh:
    * tmac/tests/an-old_CT-register-unspecified.sh:
    * tmac/tests/an-old_FT-bad-value-should-not-trash-titles.sh:
    * tmac/tests/an-old_LL-init-sanely.sh:
    * tmac/tests/an-old_TH-repairs-ad-damage.sh:
    * tmac/tests/an-old_TH-repairs-hy-damage.sh:
    * tmac/tests/an-old_TS-do-not-keep-tables-when-cR-set.sh:
    * tmac/tests/an-old_X-register-works.sh:
    * tmac/tests/an-old_avoid-two-font-denial-of-service.sh:
    * tmac/tests/an-old_no-break-after-short-paragraph-tags.sh:
    * tmac/tests/an-old_page-footers-present.sh:
    * tmac/tests/an-old_page-header-has-current-data.sh:
    * tmac/tests/an-old_title-abbreviation-works.sh: Rename...

    * tmac/tests/an_AT-and-UC-footer-saved-and-restored.sh:
    * tmac/tests/an_CS-register-off.sh:
    * tmac/tests/an_CS-register-on.sh:
    * tmac/tests/an_CS-register-unspecified.sh:
    * tmac/tests/an_CT-register-off.sh:
    * tmac/tests/an_CT-register-on.sh:
    * tmac/tests/an_CT-register-unspecified.sh:
    * tmac/tests/an_FT-bad-value-should-not-trash-titles.sh:
    * tmac/tests/an_LL-init-sanely.sh:
    * tmac/tests/an_TH-repairs-ad-damage.sh:
    * tmac/tests/an_TH-repairs-hy-damage.sh:
    * tmac/tests/an_TS-do-not-keep-tables-when-cR-set.sh:
    * tmac/tests/an_X-register-works.sh:
    * tmac/tests/an_avoid-two-font-denial-of-service.sh:
    * tmac/tests/an_no-break-after-short-paragraph-tags.sh:
    * tmac/tests/an_page-footers-present.sh:
    * tmac/tests/an_page-header-has-current-data.sh:
    * tmac/tests/an_title-abbreviation-works.sh: ...to these.

    WARNING: This commit will not build.

commit 3b75d93eecfc0c311c59d8c232bac91b8f3aef5c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Jul 5 22:46:46 2021 +1000

    tmac/an.tmac: Delete andoc-sourcing wrapper.

    WARNING: This commit will not build.

G. Branden Robinson <gbranden>
Project Administrator
Thu 17 Jun 2021 03:28:43 PM UTC, original submission:  

I propose to rename "an-old.tmac" to simply "an.tmac".  I'm not happy with whiff of deprecation that the current nomenclature carries.  I've done a fair amount of work on the macro package source, fixing bugs, rearranging it, adding comments, and making it more accessible (or trying to).  I first mooted a rename in broad terms last October, and reiterated it in April.  No one screamed, so I propose now to be even bolder, permitting the "an" package to reclaim its proper name among the macro packages.

This would be a NEWS-worthy item because the "-man" argument to groff (or nroff, or troff) would no longer load the andoc wrapper.  Is this a problem?  You might think so.  But I think I have discovered that it is not.  Most people don't use groff(1) for batch-rendering of multiple man pages from one invocation at the command line.  If they want to render multiple man pages, they use man(1), which in turn appears to execute a separate groff process for every page.  (And most of the time, people don't ask man(1) for multiple pages anyway.)

Why do I characterize our users thus?  Because batch-rendering of multiple man pages, up through groff 1.22.4 was very buggy, yet few reports of its obvious flaws were present in the Savannah bug tracker or mentioned on this list.  I've spent considerable effort making it work better.

I think andoc.tmac is cool and wish to keep it around; apart from being useful for its stated purpose it's an excellent exhibit of how to do certain clever things with the *roff language family (and brief enough to not defy comprehension).  But I do not think the case for andoc arrogating the "-man" argument to itself is a strong one.

https://lists.gnu.org/archive/html/groff/2020-10/msg00012.html
https://lists.gnu.org/archive/html/groff/2021-04/msg00027.html

G. Branden Robinson <gbranden>
Project Administrator

 

(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 (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 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-07-06 gbranden StatusIn Progress Fixed
        Open/ClosedOpen Closed
        Planned ReleaseNone 1.23.0
    2021-07-05 gbranden StatusNone In Progress
        Assigned toNone gbranden

    Back to the top


    Powered by Savane 3.9