[bug #63957] [mdoc] Synopsis section should not be adjusted (nor hyphenated)

[G. Branden Robinson]

URL:
  <https://savannah.gnu.org/bugs/?63957>

                 Summary: [mdoc] Synopsis section should not be adjusted (nor
hyphenated)
                   Group: GNU roff
               Submitter: gbranden
               Submitted: Fri 24 Mar 2023 07:26:25 AM UTC
                Category: Macro mdoc
                Severity: 3 - Normal
              Item Group: Rendering/Cosmetics
                  Status: In Progress
                 Privacy: Public
             Assigned to: gbranden
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None


    _______________________________________________________

Follow-up Comments:


-------------------------------------------------------
Date: Fri 24 Mar 2023 07:26:25 AM UTC By: G. Branden Robinson <gbranden>
This is a cosmetic regression from groff 1.22.4.

Input:


.Dd June 6, 1944
.Dt timerdday 3bsd
.Os
.Sh Name
.Nm timerdday
.Nd compute time of launch operation within window
.Sh Synopsis
.Ft void
.Fn timerdday "\%struct-timespec *earliest" \
"\%struct-timespec *latest" "\%struct-timespec *resolution"
.Sh Description
Compute the optimal start time for a desired event to occur between
times
.Va earliest No and Va latest
to within a granularity of
.Va resolution .


groff 1.22.4 output:


$ groff -mandoc -Tascii ATTIC/timerdday.mdoc | cat -s
mdoc warning: Empty input line #34

Name
     timerdday -- compute time of launch operation within window

Synopsis
     void timerdday(struct-timespec *earliest, struct-timespec *latest,
     struct-timespec *resolution)

Description
     Compute the optimal start time for a desired event to occur between
times
     earliest and latest to within a granularity of resolution.



(Yes, "cat -s" is necessary; yes, headers and footers are missing; and yes,
groff 1.22.4 mdoc really does produce that empty line diagnostic.)

groff Git HEAD output:


$ ./build/test-groff -mandoc -Tascii ATTIC/timerdday.mdoc | cat -s
timerdday(3bsd)                      LOCAL                    
timerdday(3bsd)

Name
       timerdday -- compute time of launch operation within window

Synopsis
       void
       timerdday(struct-timespec     *earliest,    struct-timespec   
*latest,
           struct-timespec *resolution);

Description
       Compute the optimal start time for a desired  event  to  occur 
between
       times earliest and latest to within a granularity of resolution.

GNU                              June 6, 1944                 
timerdday(3bsd)


So, a big improvement except for the giant gaps in the function prototype.

Reported by Alex Colomar to
[https://lists.gnu.org/archive/html/groff/2023-03/msg00079.html the groff
discussion list].







    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?63957>

_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/