bugGNU roff - Bugs: bug #60504, [PATCH] document .PF macro in...

 
 

bug #60504: [PATCH] document .PF macro in pic(1) and add it to -mpic

Submitter:  Dave <barx>
Submitted:  Mon 03 May 2021 08:05:53 AM UTC
   
 
Category:  Preprocessor pic 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
   

Jump to the original submission

Wed 17 Aug 2022 11:04:31 AM UTC, comment #6: 

Also see bug #62900 and bug #62901.

G. Branden Robinson <gbranden>
Group administrator
Thu 27 Jan 2022 11:25:06 PM UTC, comment #5: 

Now opened bug #61949 to catch the (hopefully) last of the stragglers.

Dave <barx>
Group Member
Wed 08 Dec 2021 12:04:07 AM UTC, comment #4: 

When updating documentation about -mpic, I overlooked groff_tmac(5).  Opened bug #61633 to remedy this.

Dave <barx>
Group Member
Sun 08 Aug 2021 10:00:12 AM UTC, comment #3: 


commit cbab3f3cec56c7e2a942902da46e6e86a3db41f9
Author: Dave Kemper <saint.snit@gmail.com>
Date:   Tue Jun 1 09:06:29 2021 +0000

    pic(1): Improve PF support and documentation.

    GNU pic recognizes two possible endings of a pic block: .PE or .PF.
    This fact was documented in doc/pic.ms but not in the pic man page.  The
    minimal pic implementation provided by pic.tmac also did not include a
    .PF definition.

    * src/preproc/pic/main.cpp (main): Add dummy definition of `PF` macro.
    * tmac/pic.tmac (PF): Add macro that performs indentation only.
      (PE): Call PF for indentation.

    * doc/pic.ms (Interface to [gt]roff/How Scaling is Handled):
    * src/preproc/pic/pic.1.man (Description, Options): Mention `PF` in
      addition to `PS` and `PE`.

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

    Also fixes an extraneous parenthesis in pic.ms.

    [Changes to pic(1) hand-merged with my recent updates to the page text.
    --GBR]


G. Branden Robinson <gbranden>
Group administrator
Tue 01 Jun 2021 09:06:29 AM UTC, comment #2: 

I've updated the patch with one additional change.  It turns out pic itself didn't support .PF as fully as it could.

Part of pic's output includes empty definitions of .PS and .PE if they're not already defined.  This can be seen by giving it empty input:


$ pic < /dev/null
.do if !dPS .ds PS
.do if !dPE .ds PE
.lf 1 -
$


The updated patch now adds a dummy .PF to this output.

This will ameliorate the problem in the macro packages (listed in comment #1) that include a .PE but no .PF definition.

(file #51504)

Dave <barx>
Group Member
Sat 08 May 2021 04:11:37 PM UTC, comment #1: 

(The following bugs address the .PF omission in other macro packages that already support .PS and .PE:


-man and -mdoc appear to lack support for any of the pic macros.

-mm supports .PS and .PE, but it's not clear whether or how it should support pic's .PF, as -mm already uses .PF as a page-footer macro.)

Dave <barx>
Group Member
Mon 03 May 2021 08:05:53 AM UTC, original submission:  

(This bug was unearthed while poking into bug #60479.)

GNU pic recognizes two possible endings of a pic block: .PE or .PF.  This fact is documented in doc/pic.ms but not in the pic man page (src/preproc/pic/pic.1.man).

The man page and pic.ms both mention that the user can use -mpic to get a minimal implementation of the .PS and .PE macros.  This small macro file (tmac/pic.tmac), however, also does not include a .PF definition.

The attached patch remedies both of these oversights.  It also corrects pic.ms (to note that pic passes through .PF in addition to .PE, and to remove one unmatched closing parenthesis) and updates it (to account for the above change to pic.tmac).

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 #51504:  pic.patch added by barx (3KiB - text/x-patch - updated patch, per comment #2)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (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 8 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-08-08 gbranden StatusIn Progress Fixed
        Open/ClosedOpen Closed
        Planned ReleaseNone 1.23.0
    2021-08-06 gbranden StatusNone In Progress
        Assigned toNone gbranden
    2021-06-01 barx Attached File#51374 Removed
    2021-06-01 barx Attached File- Added pic.patch, #51504
    2021-05-03 barx Attached File- Added pic.patch, #51374

    Back to the top

    Powered by Savane 3.13-758e.
    Corresponding source code