bug-standards
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Using VC for change descriptions


From: Alfred M. Szmidt
Subject: Re: Using VC for change descriptions
Date: Tue, 02 Jan 2018 02:48:27 -0500

   I gave an example in 
   <https://lists.gnu.org/archive/html/bug-standards/2017-07/msg00002.html> 
   (bug-standards, Fri, 28 Jul 2017 23:47:19 +0000), both of a ChangeLog 
   entry and of the corresponding logical description (summary line plus two 
   descriptive paragraphs) that actually explains what changed at a more 
   human-comprehensible level.

The example ChangeLog is not a good example, since that is how you are
supposed to write them.  I showed you a much shorter, and much more
legible version of the same in a follow-up email.  

You "summary description" while useful and could/should be included as
part of the ChangeLog entry (or commit message), does not tell the
reader _what_ changed _where_.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]