[bug #62036] [PATCH] Document how environments are initialized

[Dave]

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

                 Summary: [PATCH] Document how environments are initialized
                 Project: GNU troff
            Submitted by: barx
            Submitted on: Fri 11 Feb 2022 09:13:18 PM CST
                Category: Core
                Severity: 1 - Wish
              Item Group: Documentation
                  Status: None
                 Privacy: Public
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
         Planned Release: None

    _______________________________________________________

Details:

Classical troff lacked the ability to create new environments.  Three were
established at the outset, and CSTR #54 explicitly stated, "All environments
are initialized with default parameter values."

Groff starts up with only one environment ("0"), but users can create an
unlimited number of environments as needed.  However, its documentation fails
to mention how environments are populated upon creation.

The attached patch remedies this.  It says the environment "is created using
GNU troff's start-up defaults for all environment-specific parameters," which
appears to be accurate for the cases I tested.  But if there are other cases
where this is not accurate, let me know and I'll adjust this wording.

==== Other notes ====

The overall manual inconsistently uses both "start-up" (23 instances) and
"startup" (3 instances), whether in noun or adjective context.  I went with
the majority spelling in this patch.  American Heritage Dictionary says both
are valid (http://ahdictionary.com/word/search.html?q=startup).

Everywhere the manual says something "is associated with the environment,"
this is followed by "(@pxref{Environments})."  This was missing in one place;
as a bonus fix, the patch corrects this.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: Fri 11 Feb 2022 09:13:18 PM CST  Name: 62036.patch  Size: 1KiB   By:
barx

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

    _______________________________________________________

Reply to this item at:

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

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