[no subject]

[Gavin D. Smith]

branch: master
commit d6e8ad399e6fcf55efb82a56ff618c44512df3ef
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Sun Oct 15 12:55:42 2023 +0100

    * README-hacking: update
---
 ChangeLog                    |  4 ++
 README-hacking               | 98 +++++++++++++++++++++++---------------------
 tp/tests/coverage_macro.texi |  2 +
 3 files changed, 57 insertions(+), 47 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 69ad0950db..89be335fd3 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2023-10-15  Gavin Smith <gavinsmith0123@gmail.com>
+
+       * README-hacking: update
+
 2023-10-15  Gavin Smith <gavinsmith0123@gmail.com>
 
        * tp/Texinfo/XS/parsetexi/api.c (reset_parser): Update comment
diff --git a/README-hacking b/README-hacking
index 7845b65339..f4761a8333 100644
--- a/README-hacking
+++ b/README-hacking
@@ -203,55 +203,12 @@ programming system, combining Texinfo and Awk
 in the texindex/ subdirectory creates the printable form of the
 program.  All the usual Texinfo output formats are possible.
 
-
 
-Steps for making a release (pretest or official):
 
-- When close to official release:
+- Updating copyright years in files
 
-NYTProf profiling for Perl code
-* e.g. 'perl -d:NYTProf ../tp/texi2any.pl FILE.texi'.  See Devel::NYTProf
-  man page.
-callgrind profiling for XS code
-* e.g. 'LD_BIND_NOW=1 valgrind --tool=callgrind perl ../tp/texi2any.pl \
-  FILE.texi' then 'kcachegrind callgrind.out.*'.
-
-run all tests with valgrind:
-* under info/t, put valgrind in $ginfo, then check t/*.val.log files after
-  running test suite
-* edit install-info/tests/defs.in, uncomment valgrind line and run
-  config.status to regenerate defs
-* XS modules memory leak check checking with valgrind
-  Add line "use Perl::Destruct::Level level => 1;" to texi2any.pl
-  when running 'valgrind --leak-check=full' to make perl clean it
-  its allocations.  Run e.g.
-      valgrind --log-file=val.log --leak-check=full \
-        perl ../tp/texi2any.pl ../doc/info-stnd.texi
-  and other input files.
-
-  Add line "use Perl::Destruct::Level level => 1;" to t/test_utils.pl
-  Check tests with e.g.
-    for f in t/*.t ; do valgrind --log-file=val.log-${f#t/} --leak-check=full \
-          perl -w $f ; done
- (could take 1-2 hours to finish).  check log files one by one afterwards.
-
-Manual testing:
-. try groff.texinfo from groff source repo.
-. process doc/texinfo-tex-test.texi with TeX and check that output is good.
-. process some manuals with INFO_JS_DIR and check the JS interface is
-  not broken.
-
-check for C compiler warnings by configuring with
-
-our_CFLAGS='-Wall -Wno-parentheses -Wno-missing-braces'
-./configure "CFLAGS=$our_CFLAGS" "PERL_EXT_CFLAGS=$our_CFLAGS"
-unset our_CFLAGS
-
-Not all compiler warnings have to be fixed, though.
-
-
-Check if copyright years in files have all been updated.  It may be
-simplest just to update them all.  First, look for lone copyright years:
+It may be simplest just to update them all at once.  First, look for
+lone copyright years:
 
 find . -type f \
   \( -name '*' \) \
@@ -295,6 +252,51 @@ find . \
 
 at the top level.
 
+(We should automate this process in the future.)
+
+
+
+- When close to making a release:
+
+NYTProf profiling for Perl code
+* e.g. 'perl -d:NYTProf ../tp/texi2any.pl FILE.texi'.  See Devel::NYTProf
+  man page.
+callgrind profiling for XS code
+* e.g. 'LD_BIND_NOW=1 valgrind --tool=callgrind perl ../tp/texi2any.pl \
+  FILE.texi' then 'kcachegrind callgrind.out.*'.
+
+run all tests with valgrind:
+* under info/t, put valgrind in $ginfo, then check t/*.val.log files after
+  running test suite
+* edit install-info/tests/defs.in, uncomment valgrind line and run
+  config.status to regenerate defs
+* XS modules memory leak check checking with valgrind
+  Add line "use Perl::Destruct::Level level => 1;" to texi2any.pl
+  when running 'valgrind --leak-check=full' to make perl clean it
+  its allocations.  Run e.g.
+      valgrind --log-file=val.log --leak-check=full \
+        perl ../tp/texi2any.pl ../doc/info-stnd.texi
+  and other input files.
+
+  Add line "use Perl::Destruct::Level level => 1;" to t/test_utils.pl
+  Check tests with e.g.
+    for f in t/*.t ; do valgrind --log-file=val.log-${f#t/} --leak-check=full \
+          perl -w $f ; done
+ (could take 1-2 hours to finish).  check log files one by one afterwards.
+
+Manual testing:
+. try groff.texinfo from groff source repo.
+. process doc/texinfo-tex-test.texi with TeX and check that output is good.
+. process some manuals with INFO_JS_DIR and check the JS interface is
+  not broken.
+
+check for C compiler warnings by configuring with
+
+our_CFLAGS='-Wall -Wno-parentheses -Wno-missing-braces'
+./configure "CFLAGS=$our_CFLAGS" "PERL_EXT_CFLAGS=$our_CFLAGS"
+unset our_CFLAGS
+
+Not all compiler warnings have to be fixed, though.
 
 check at latest automake/autoconf/gettext/help2man version:
   . to upgrade gettext, run
@@ -328,7 +330,7 @@ Check "make ccheck" and "make vcheck" work in "doc/refcard".
 make V=1 pdf and fix underfull/overfull boxes.
 
 -------------------------------------------------------------------------
-- Final steps
+- Final steps for making a release
 
 (Keep a copy of README-hacking open in a text editor to update these
 release instructions.)
@@ -342,6 +344,8 @@ Have a look at the output of "git status -u" to check for 
files that
 
 check "git stash list" for any work in progress
 
+Check if "make tex-html-checks" results have been updated under tp/tests.
+
 check OpenCSW build reports at
   https://buildfarm.opencsw.org/buildbot/waterfall?category=texinfo
 (for master branch only)
diff --git a/tp/tests/coverage_macro.texi b/tp/tests/coverage_macro.texi
index d191c71056..1b70dc7c66 100644
--- a/tp/tests/coverage_macro.texi
+++ b/tp/tests/coverage_macro.texi
@@ -105,9 +105,11 @@ but , ,@:
 @@LaTeX @LaTeX{}
 @@bullet @bullet{} (•)
 @@copyright @copyright{} (©)
+
 @@dots @dots{} (…)
 @@enddots @enddots{}
 @@equiv @equiv{} (≡)
+
 @@error @error{}
 @@expansion @expansion{} (↦)
 @@minus @minus{} (−)