GNU bug report logs - #38333
misc doc changes for vc-dwim [patch]

Message received at submit <at> debbugs.gnu.org:

Received: (at submit) by debbugs.gnu.org; 22 Nov 2019 22:51:43 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Fri Nov 22 17:51:43 2019
Received: from localhost ([127.0.0.1]:55679 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1iYHm5-0006ga-7t
	for submit <at> debbugs.gnu.org; Fri, 22 Nov 2019 17:51:41 -0500
Received: from lists.gnu.org ([209.51.188.17]:37560)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <karl@HIDDEN>) id 1iYHlt-0006gB-JT
 for submit <at> debbugs.gnu.org; Fri, 22 Nov 2019 17:51:33 -0500
Received: from eggs.gnu.org ([2001:470:142:3::10]:45908)
 by lists.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <karl@HIDDEN>) id 1iYHlq-0003hx-So
 for bug-vc-dwim@HIDDEN; Fri, 22 Nov 2019 17:51:25 -0500
X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org
X-Spam-Level: 
X-Spam-Status: No, score=-1.5 required=5.0 tests=BAYES_50,RCVD_IN_DNSWL_MED,
 T_FILL_THIS_FORM_SHORT,URIBL_BLOCKED autolearn=disabled version=3.3.2
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <karl@HIDDEN>) id 1iYHlo-00063b-QX
 for bug-vc-dwim@HIDDEN; Fri, 22 Nov 2019 17:51:22 -0500
Received: from freefriends.org ([96.88.95.60]:56024)
 by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)
 (Exim 4.71) (envelope-from <karl@HIDDEN>)
 id 1iYHlo-00062R-ET
 for bug-vc-dwim@HIDDEN; Fri, 22 Nov 2019 17:51:20 -0500
X-Envelope-From: karl@HIDDEN
X-Envelope-To: <bug-vc-dwim@HIDDEN>
Received: from freefriends.org (freefriends.org [96.88.95.60])
 by freefriends.org (8.14.7/8.14.7) with ESMTP id xAMMpHf9004493
 (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT)
 for <bug-vc-dwim@HIDDEN>; Fri, 22 Nov 2019 15:51:18 -0700
Received: (from apache@localhost)
 by freefriends.org (8.14.7/8.14.7/Submit) id xAMMpHBE004491;
 Fri, 22 Nov 2019 15:51:17 -0700
Date: Fri, 22 Nov 2019 15:51:17 -0700
Message-Id: <201911222251.xAMMpHBE004491@HIDDEN>
From: Karl Berry <karl@HIDDEN>
To: bug-vc-dwim@HIDDEN
Subject: misc doc changes for vc-dwim [patch]
X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]
 [fuzzy]
X-Received-From: 96.88.95.60
X-Spam-Score: -1.4 (-)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -0.1 (/)

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  <karl@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 <jim@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