summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorG. Branden Robinson <g.branden.robinson@gmail.com>2022-05-26 09:29:16 -0500
committerG. Branden Robinson <g.branden.robinson@gmail.com>2022-05-26 09:29:16 -0500
commitc893202d20273c037cb4007e70f38bdc17946cb4 (patch)
tree70e363c771ef85b9aec2965d66c0d53e0992fce7 /HACKING
parenteb5a7d0041923247c2108546d8490bb615d1c5d9 (diff)
downloadgroff-git-c893202d20273c037cb4007e70f38bdc17946cb4.tar.gz
FOR-RELEASE, HACKING, INSTALL.REPO, README: Tweak.
* FOR-RELEASE: Split-off ChangeLog files need to be added to the distribution archive. * HACKING: Clarify non-ChangeLoggable items. Generally, an item that resolves a Savannah ticket should be ChangeLogged even if it would not normally meet that threshold. Also clarify a point in an example; we certainly expect table entries containing the word "FOOBAR" to show up that way when formatted. * INSTALL.REPO: Correct prose description of what to do with unpacked "gnulib" snapshot. * README: Clarify that the '.version' file is produced by the build process. Clarify origins and provenance of various groff components. Use a more appropriate URL for the Savannah issue tracker. Lightly recast.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING10
1 files changed, 5 insertions, 5 deletions
diff --git a/HACKING b/HACKING
index ff7014d77..94c3ad7aa 100644
--- a/HACKING
+++ b/HACKING
@@ -37,9 +37,9 @@ Changes may need to be documented in up to three places depending on
their impact.
1. Changes should of course be documented in the Git commit message.
- If a change does not resolve a Savannah ticket, alters only
- comments to source code, or makes editorial changes to
- documentation, you can stop at that.
+ If a change alters only comments or formatting of source code, or
+ makes editorial changes to documentation, and does not resolve a
+ Savannah ticket, you can stop at that.
2. The 'ChangeLog' file follows the format and practices documented in
the GNU Coding Standards.
@@ -62,8 +62,8 @@ their impact.
As a hypothetical example, correcting a rendering error in tbl(1)
such that any table with more than 20 rows no longer had the text
- "FOOBAR" added to some of entries would not be a 'NEWS' item,
- because the appearance of such text in the first place is a
+ "FOOBAR" spuriously added to some of entries would not be a 'NEWS'
+ item, because the appearance of such text in the first place is a
surprising deviation from tbl's ideal and historical behavior. In
contrast, adding a command-line option to tbl, or changing the
meaning of its "expand" region option such that it no longer