[Bug-vc-dwim] bug#38333: misc doc changes for vc-dwim [patch]

[Karl Berry]

Also, README-hacking refers to README-prereq, which is not the repository.
I wasn't sure if it would somehow get pulled in somewhere, somehow
(although that seems paradoxical). -k

2019-11-14  Karl Berry  <address@hidden>

        doc: Small documentation changes.
        
        * vc-dwim.pl: add conventional urls for home page and general
        GNU help at end.
        * doc/vc-dwim.texi (Introduction),
        (Reporting bugs): omit trivial cindex entries (not printed); wording.
        (vc-dwim Invocation): less dogmatic about other editors.
        (Using vc-chlog): subheadings to break up long node, other wording.
        (vc-chlog Invocation) <--debug>: more.
        (vc-chlog Internals): grammar.
        
--- doc/vc-dwim.texi    2019-11-13 17:36:14.920575492 -0800
+++ misc.texi   2019-11-14 18:20:03.878009981 -0800
@@ -94,5 +94,4 @@
 @node Introduction
 @chapter Introduction
-@cindex Introduction
 
 vc-dwim is a version-control-agnostic @file{ChangeLog} diff and commit
@@ -274,5 +273,5 @@
 Relies on fairly strict adherence to recommended @file{ChangeLog}
 syntax.  Detects editor temporaries created by Emacs and Vim.
-Eventually, it will detect temporaries created by other editors.
+Patches to detect temporaries created by other editors are welcome.
 
 
@@ -316,4 +315,6 @@
 on standard output.
 
+@subheading Finding identifiers for what has changed:
+
 There is a crucial assumption behind this idea to work well in practice:
 ctags should be able to generate tags for the identifiers that changed.
@@ -343,5 +344,5 @@
 
 @noindent
-it detects Texinfo node names (@command{vc-chlog} uses some heuristic to
+it detects Texinfo node names (@command{vc-chlog} uses some heuristics to
 deal with spaces in the identifier names when Exuberant Ctags is used).
 
@@ -365,10 +366,10 @@
 
 Typically, @command{vc-chlog} is exact in the list of files that
-changed, false negatives in the list of identifiers stem from a
+changed; false negatives in the list of identifiers stem from a
 @command{ctags} that failed to enumerate all identifiers properly, or
-changes before a function, false positives typically stem from
+changes before a function, and false positives typically stem from
 constructs like nested functions.
 
-Use @command{vc-chlog} with multiple @file{ChangeLog} files in a project
+@subheading Use @command{vc-chlog} with multiple @file{ChangeLog} files in a 
project:
 
 If a project uses multiple @file{ChangeLog} files, @command{vc-chlog}
@@ -427,5 +428,5 @@
 
 @item --debug
-Inhibit temp file cleanup.
+Inhibit temp file cleanup and show much shell execution.
 
 @item --help
@@ -475,5 +476,5 @@
 identifiers will later be assumed to change the earlier of the two.
 
-While this works reasonably well for functions, it fails for example for
+While this works reasonably well for functions, it fails, for example, for
 global variable declarations or changes to comments outside of
 functions.  So @code{func_taglist} applies some heuristics to guess the
@@ -494,5 +495,5 @@
 formatted with @code{func_pretty_changelog_entry}.
 
-The fact that @command{vc-chlog} is written as portable shell script,
+The fact that @command{vc-chlog} is written as a portable shell script,
 using @command{awk}, @command{sed}, and other POSIX tools freely, adds
 to the compactness of the script, added to the fun in writing it,
@@ -503,6 +504,5 @@
 @section Reporting bugs
 
-@cindex bugs, reporting
-Email bug reports to @email{bug-vc-dwim@@gnu.org},
+Email bug reports and all other discussion to @email{bug-vc-dwim@@gnu.org},
 a mailing list whose web page is
 @url{https://lists.gnu.org/mailman/listinfo/bug-vc-dwim}.
--- vc-dwim.pl  2019-11-13 17:36:14.932575295 -0800
+++ misc.pl     2019-11-17 18:37:30.707892115 -0800
@@ -1275,5 +1275,9 @@
 Jim Meyering <address@hidden>
 
-Report bugs to <@PACKAGE_BUGREPORT@>.
+Report bugs and all other discussion to <@PACKAGE_BUGREPORT@>.
+
+GNU <@PACKAGE_NAME> home page: 
&lt;https://www.gnu.org/software/<@PACKAGE_NAME>/&gt;
+
+General help using GNU software: <https://www.gnu.org/gethelp/>
 
 =cut