[groff] 05/25: HACKING: Add gnulib update procedure.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit a931d3845e903a43cff28abd694ce24e85e4f530
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Jul 18 09:30:17 2024 -0500

    HACKING: Add gnulib update procedure.
    
    FOR-RELEASE: Cross-reference new material.
---
 FOR-RELEASE |  3 ++-
 HACKING     | 20 ++++++++++++++++++++
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/FOR-RELEASE b/FOR-RELEASE
index d9e426b16..44b77effd 100644
--- a/FOR-RELEASE
+++ b/FOR-RELEASE
@@ -37,7 +37,8 @@ This file describes how to prepare 'groff' for a new release.
      (<https://raw.githubusercontent.com/adobe-type-tools/agl-aglfn/\
      master/glyphlist.txt> may be more convenient.)
 
-* Update the 'gnulib' sub-module to the latest stable version.
+* Update the 'gnulib' sub-module and 'bootstrap' script to the latest
+  stable versions.  See the 'HACKING' file for instructions.
 
 * Update the release version number where it is hard-coded.
   + NEWS
diff --git a/HACKING b/HACKING
index faf40f29f..4e731a042 100644
--- a/HACKING
+++ b/HACKING
@@ -214,6 +214,26 @@ Here are some portability notes on writing automated tests.
     }
 
 
+Updating gnulib
+---------------
+
+Here's how to update the submodule, using that project's "stable-202407"
+branch as an example.  From the root of your checkout:
+
+  $ cd gnulib
+  $ git checkout -b stable-202407 --track origin/stable-202407
+  $ git pull
+  $ cd ..
+  $ editor ChangeLog # log it
+  $ git commit
+
+It's likely a good idea to update the "bootstrap" script at the same
+time (not necessarily in the same commit, however).
+
+  $ ./bootstrap --bootstrap-sync
+  $ editor ChangeLog # log it
+  $ git commit
+
 ##### Editor settings
 Local Variables:
 fill-column: 72