branch master updated: * README-hacking: say to test JS interface manually before a release * README: list js/ directory here.

[Gavin D. Smith]

This is an automated email from the git hooks/post-receive script.

gavin pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new d39dad2685 * README-hacking: say to test JS interface manually before 
a release * README: list js/ directory here.
d39dad2685 is described below

commit d39dad26855f8eb10b05111f669225dfe65612e3
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Sun Nov 20 10:21:51 2022 +0000

    * README-hacking: say to test JS interface manually before a release
    * README: list js/ directory here.
---
 ChangeLog      |  5 +++++
 README         |  5 +++--
 README-hacking | 50 +++++++++++++++++++++++++++-----------------------
 3 files changed, 35 insertions(+), 25 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 0d85d7788d..cc74f5d597 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2022-11-20  Gavin Smith  <gavinsmith0123@gmail.com>
+
+       * README-hacking: say to test JS interface manually before a release
+       * README: list js/ directory here.
+
 2022-11-20  Gavin Smith  <gavinsmith0123@gmail.com>
 
        * tp/Texinfo/Convert/HTML.pm (%defaults): Change INDEX_ENTRY_COLON
diff --git a/README b/README
index a6f5ed5a03..b9c3ffab59 100644
--- a/README
+++ b/README
@@ -24,7 +24,7 @@ many forms of output:
 - a LaTeX file, which can then be used to create a PDF
 - a Docbook file
 
-See ./INSTALL* for installation instructions.
+See INSTALL* for installation instructions.
 
 To get started with Texinfo, you can read the Texinfo manual
 online at https://www.gnu.org/software/texinfo/manual/texinfo.
@@ -77,7 +77,7 @@ Texinfo documentation files
                            much else.
 
     doc/info-stnd.texi     How to use the standalone GNU Info reader that is
-                           included in this distribution (./info).
+                           included in this distribution.
 
 Printing-related files:
     doc/texinfo.tex        This implements Texinfo in TeX, to typeset a
@@ -94,6 +94,7 @@ Source directories:
   info/                    Standalone Info reader.
   install-info/            Maintain the Info dir file.
   tp/                      Texinfo Parser in Perl, includes texi2any.
+  js/                      Enhanced browsing of HTML manuals with JavaScript.
   texindex/                The `texindex' program that generates
                            sorted indices used by TeX when
                            typesetting a file for printing.
diff --git a/README-hacking b/README-hacking
index 938a0b5ecc..54d9284b39 100644
--- a/README-hacking
+++ b/README-hacking
@@ -49,7 +49,7 @@ Additionally, make dist may not work until make has been run 
at least
 once, because of rules to create man pages under the man/ directory.
 
 "make dist" will fail if the use of Perl XS extension modules is 
-disabled and there is no Makefile in the XSParagraph subdirectory.
+disabled and there is no Makefile in the XS subdirectory.
 
 
 Using git
@@ -134,7 +134,6 @@ Subdirectories in repository
 In addition to the subdirectories listed in README, there is the 
 following directory in the source control repository:
 
-js/ - Work on enhanced browsing of HTML manuals with JavaScript
 infog/ - HTML-Info reader using WebKitGTK library
 
 Finally, the contrib/ directory contains additional files from users
@@ -195,21 +194,22 @@ Steps for making a release (pretest or official):
 
 - When close to official release:
 
-check at latest automake/autoconf/gettext version, and mention in NEWS
-(to upgrade gettext, run
-  gettextize -f --po-dir=po --po-dir=po_document
-after installing new version of gettext.
-check that this does not actually downgrade files due to files also
-being updated from gnulib --add-import)
-
-# Under the top level, and also under tp/Texinfo/XS, which uses
-# a separate gnulib import.
-gnulib-tool --add-import
-'git status -u' and add untracked files
-
-After upgrading automake/autoconf/gettext, run ./autogen.sh
-and/or "autoreconf --verbose --force --install" to update ancilliary
-files in build-aux and elsewhere.  Check changes before committing.
+check at latest automake/autoconf/gettext version:
+  . to upgrade gettext, run
+      gettextize -f --po-dir=po --po-dir=po_document
+    after installing new version of gettext.
+    (check that this does not actually downgrade files due to files also
+    being updated from gnulib --add-import)
+  . After upgrading automake/autoconf/gettext, run ./autogen.sh
+    and/or "autoreconf --verbose --force --install" to update ancilliary
+    files in build-aux and elsewhere.  Check changes before committing.
+  . mention new versions in NEWS
+
+Update gnulib:
+  # Under the top level, and also under tp/Texinfo/XS, which uses
+  # a separate gnulib import.
+  gnulib-tool --add-import
+  'git status -u' and add untracked files
 
 Use util/srclist-txi for checking files to be copied from gnulib
 
@@ -218,17 +218,12 @@ run all tests with valgrind:
   running test suite
 * edit install-info/tests/defs.in, uncomment valgrind line and run
   config.status to regenerate defs
-
-parsetexi memory leak checks with valgrind
+* XS modules memory leak check checking with valgrind
 
 NYTProf profiling for Perl code
 * e.g. 'perl -d:NYTProf ../tp/texi2any.pl FILE.texi'.  See Devel::NYTProf
   man page.
 
-
-try groff.texinfo from groff source repo.
-Check "make ccheck" and "make vcheck" work in "doc/refcard".
-process doc/texinfo-tex-test.texi with TeX and check that output is good.
 check for C compiler warnings by configuring with
 
   ./configure CFLAGS='-Wall -Wdeclaration-after-statement' \
@@ -241,13 +236,22 @@ don't support it are still widespread.
 
 Not all compiler warnings have to be fixed, though.
 
+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.
+
 Have a look at the output of "git status -u" to check for files that
   should be tracked in git or ignored.
+
 make po-check             # update po/POTFILES.in as needed
 make po_document-check    # update po_document/POTFILES.in as needed
 
 check indices of Texinfo manuals and check for duplicates (with <1> in Info)
 
+Check "make ccheck" and "make vcheck" work in "doc/refcard".
+
 - Official releases only:
 make V=1 pdf and fix underfull/overfull boxes.