bugGNU roff - Bugs: bug #42515, clean up macro name spaces...

 
 

bug #42515: clean up macro name spaces regarding "need_eo_{h,tl}"

Submitter:  Dave <barx>
Submitted:  Fri 06 Jun 2014 10:03:10 AM UTC
   
 
Category:  Macro - others/general Severity:  3 - Normal
Item Group:  Lint Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.23.0
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 16 Jun 2021 11:58:00 PM UTC, comment #4: 


commit 664613412bd99758e31cf46156464474144ade1c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Wed Jun 16 22:35:57 2021 +1000

    tmac/an-old.tmac: Improve name space usage.

    * tmac/an-old.tmac: Properly situate devtag flag-related register names
      in the package name space.  Rename `need_eo_h` to
      `an-devtag-needs-end-of-heading'.  Rename `need_col2` to
      `an-devtag-needs-second-column`.

      (an-input-trap, SH, SS, HP, (initialization)): Do it.

      (an-input-trap): Test their values more idiomatically.

    Fixes one third of <https://savannah.gnu.org/bugs/?42515>.

    Problem noted by Werner Lemberg in
    <http://lists.gnu.org/archive/html/groff/2014-01/msg00048.html> (but
    watch out for the Time-Cube-esque URL quoted there).

commit 0c6a585758b923616ee83b1e0c7e185408c6dea8
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Jun 17 02:54:22 2021 +1000

    tmac/e.tmac-u: Rename devtag-related registers.

    * tmac/e.tmac-u: Rename registers for clarity.  Unlike other macro
      packages supplied by groff, "me" mostly remains within the AT&T
      2-character name space, accessing extended names selectively through
      `do` and `de1` requests.  The package therefore has no characteristic
      name prefix.
        need_eo_h  -> devtag-needs-end-of-heading
        need_eo_tl -> devtag-needs-end-of-title
        need_tl    -> devtag-needs-title

      (@html_check_need_title, sh, EQ): The foregoing registers are
      effectively Booleans, so perform Boolean-style tests on their
      interpolations.

    Fixes a second third of <https://savannah.gnu.org/bugs/?42515>.

commit ead1255bd11ae4c4f16e19185a9d301df21f0146
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Jun 17 06:15:36 2021 +1000

    tmac/s.tmac: Rename devtag-related registers.

    * tmac/s.tmac: Properly situate devtag flag-related register names in
      the package name space.  Rename `need_eo_h` to
      `s@devtag-needs-end-of-heading'.  Rename `need_eo_tl` to
      `s@devtag-needs-end-of-title`.

      ((initialization), par@reset, @SH, par@finish, @NH): Do it.

      (par@reset): Test their values more idiomatically.

    Fixes last third of <https://savannah.gnu.org/bugs/?42515>.


G. Branden Robinson <gbranden>
Group administrator
Wed 16 Jun 2021 12:26:45 PM UTC, comment #3: 

I have my own fix for this; I'd prefer the register names to be more descriptive, and to be tested more idiomatically, not just resolve the inconsistent name space usage.

G. Branden Robinson <gbranden>
Group administrator
Wed 21 Oct 2020 07:02:45 AM UTC, comment #2: 

me and ms have registers of the same name for the same purpose.

So any fix should be applied to them, too.

Also I should add that the mnemonics of "need_eo_h" and "need_eo_tl" are terrible.  Maybe they were obvious to Gaius Mulley (who implemented them) but they sure are not to me.

As I understand it, these are effectively ending/closing tags for headings and titles (real titles, not headers/footers).  grohtml uses them.

If they're going to be renamed anyway, they should be renamed to have obvious meaning.

I think even "DEVTAG" is only barely intelligible, and I had to work my way through the grops(1) page to reach that understanding.  Device escapes are way down in the weeds for mere mortal users.

So I'll take this on.  Don't know if it will make it for 1.23.

G. Branden Robinson <gbranden>
Group administrator
Fri 31 Jan 2020 12:47:24 AM UTC, comment #1: 

  A missing patch is in the attachment.

(file #48309)

Bjarni Ingi Gislason <bjarniig>
Fri 06 Jun 2014 10:03:10 AM UTC, original submission:  

Werner Lemberg wrote on the groff email list (http://lists.gnu.org/archive/html/groff/2014-01/msg00048.html):

"The macro space of an-old.tmac is `an-'....  There are some violations of that in `an-old.tmac' (e.g. `need_eo_h'); this should be fixed eventually."

Dave <barx>
Group Member

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #48309:  groff.bug added by bjarniig (1KiB - application/octet-stream)

 

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 bjarniig (Updated the item)
  • -email is unavailable- added by schwarze (Updated the item)
  • -email is unavailable- added by barx (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 14 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-03-05 gbranden Item GroupFeature change Lint
    2021-06-16 gbranden StatusIn Progress Fixed
        Open/ClosedOpen Closed
        Planned ReleaseNone 1.23.0
    2021-06-16 gbranden StatusConfirmed In Progress
        Summary[PATCH] clean up macro name spaces regarding &quot;need_eo_{h,tl}&quot; clean up macro name spaces regarding "need_eo_{h,tl}"
    2020-10-21 gbranden CategoryMacro man Macro - others/general
        Assigned toNone gbranden
        Summary[PATCH] clean up an-old.tmac namespace [PATCH] clean up macro name spaces regarding "need_eo_{h,tl}"
    2020-10-13 barx Summaryclean up an-old.tmac namespace [PATCH] clean up an-old.tmac namespace
    2020-01-31 bjarniig Attached File- Added groff.bug, #48309
    2018-02-16 schwarze CategoryNone Macro man
        Item GroupNone Feature change
        StatusNone Confirmed

    Back to the top

    Powered by Savane 3.13-4448.
    Corresponding source code