bugGNU roff - Bugs: bug #64189, [PATCH] [me] for -me developers,...

 
 

bug #64189: [PATCH] [me] for -me developers, document @ register

Submitter:  Dave <barx>
Submitted:  Sun 14 May 2023 02:38:15 AM UTC
   
 
Category:  Macro package me Severity:  1 - Wish
Item Group:  Documentation Status:  None
Privacy:  Public Assigned to:  None
Open/Closed:  Open Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Sun 14 May 2023 02:38:15 AM UTC, original submission:  

The -me macro package has an undocumented register, @, that the user can set to specify a debugging level.

This is probably only useful to -me developers, so it makes sense that this wouldn't be documented in the user-facing -me documents doc/meref.me.in and doc/meintro.me.in.  But it ought to be mentioned in developer-facing -me documentation--which at present really only consists of minimal comments in tmac/e.tmac itself.  (And it is, sort of--but buried in the middle of the file, and without explanation.)

Thus the attached patch adds a few lines of comments about the register, next to other general comments about the macro file at the top of the file.

Open questions:

  • I think it's important to say that the register must be set before the package is loaded, but the instructions in this patch about how might be overexplaining to a developer.
  • Someone more ambitious than me could figure out if each of the numbers 2 through 5 represents some specific category of debugging info that is output, and document that as well.
  • If people think this capability is useful to ordinary -me users as well, then this should be placed in the user-facing documentation instead of in the source code.
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 #54740:  64189.patch added by barx (827B - text/x-diff)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -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.

     

    Follows 1 latest change.

    Date Changed by Updated Field Previous Value => Replaced by
    2023-05-14 barx Attached File- Added 64189.patch, #54740

    Back to the top

    Powered by Savane 3.13-4b48.
    Corresponding source code