[bug #61314] [PATCH] [me] clarify documentation of $v and $V registers

[Dave]

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

                 Summary: [PATCH] [me] clarify documentation of $v and $V
registers
                 Project: GNU troff
            Submitted by: barx
            Submitted on: Sat 09 Oct 2021 02:40:51 AM CDT
                Category: Macro - me
                Severity: 2 - Minor
              Item Group: Documentation
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None

    _______________________________________________________

Details:

The -me Reference Manual is fairly scrupulous about documenting the default
values of its registers, but $v and $V are two exceptions.  The attached patch
documents the default values for these (both 120).


$ groff -me <<<'.tm \n($v \n($V'
120 120


There is also what I feel is an oddity in the nearby wording: "The line
spacing as a percentage of the point size expressed in units is stored in
\n($v."  I'm not sure what the phrase "expressed in units" is supposed to
communicate; it's not clear whether it modifies "line spacing" or "point
size," and neither really makes sense, even mentally adding the presumably
intended "basic" before "units."

 * $v is a percentage; if it meaningfully has a unit at all, that unit is %.
 * In what units the point size is expressed or stored is irrelevant to a
percentage: 120% of the point size is not dependent on the units expressing
that point size.

Thus this patch removes the phrase entirely.  If someone has a better idea
what that phrase is trying to say, it could instead be reworded to say it more
clearly.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: Sat 09 Oct 2021 02:40:51 AM CDT  Name: meref.me.line_spacing.patch 
Size: 531B   By: barx

<http://savannah.gnu.org/bugs/download.php?file_id=52079>

    _______________________________________________________

Reply to this item at:

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

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