comparison doc/standards.texi @ 39219:d67dde969503

autoupdate
author Karl Berry <karl@freefriends.org>
date Wed, 17 Jan 2018 10:09:24 -0800
parents c30b1aa76212
children 23ad3b8b44d9
comparison
equal deleted inserted replaced
39218:c30b1aa76212 39219:d67dde969503
26 @copying 26 @copying
27 The GNU coding standards, last updated @value{lastupdate}. 27 The GNU coding standards, last updated @value{lastupdate}.
28 28
29 Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 29 Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
30 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 30 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
31 2011, 2012, 2013, 2014, 2015, 2016 Free Software Foundation, Inc. 31 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 Free Software Foundation, Inc.
32 32
33 Permission is granted to copy, distribute and/or modify this document 33 Permission is granted to copy, distribute and/or modify this document
34 under the terms of the GNU Free Documentation License, Version 1.3 or 34 under the terms of the GNU Free Documentation License, Version 1.3 or
35 any later version published by the Free Software Foundation; with no 35 any later version published by the Free Software Foundation; with no
36 Invariant Sections, no Front-Cover Texts, and no Back-Cover 36 Invariant Sections, no Front-Cover Texts, and no Back-Cover
3563 @cindex description, change log entry 3563 @cindex description, change log entry
3564 It is a good idea to start the change log entry with a description 3564 It is a good idea to start the change log entry with a description
3565 of the overall change. This should be as long as needed to give 3565 of the overall change. This should be as long as needed to give
3566 a clear description. 3566 a clear description.
3567 3567
3568 The give a list of names of the entities or definitions that you 3568 Then give a list of names of the entities or definitions that you
3569 changed, according to the files they are in, and what was changed 3569 changed, according to the files they are in, and what was changed
3570 in each one. @xref{Style of Change Logs}. 3570 in each one. @xref{Style of Change Logs}.
3571 3571
3572 The change log file is normally called @file{ChangeLog} and covers an 3572 The change log file is normally called @file{ChangeLog} and covers an
3573 entire directory. Each directory can have its own change log, or a 3573 entire directory. Each directory can have its own change log, or a
3693 3693
3694 There's no technical need to make change log entries for non-software 3694 There's no technical need to make change log entries for non-software
3695 files (manuals, help files, media files, etc.). This is because they 3695 files (manuals, help files, media files, etc.). This is because they
3696 are not susceptible to bugs that are hard to understand. To correct 3696 are not susceptible to bugs that are hard to understand. To correct
3697 an error, you need not know the history of the erroneous passage; it 3697 an error, you need not know the history of the erroneous passage; it
3698 is enough to compare what the file says with the the actual facts. 3698 is enough to compare what the file says with the actual facts.
3699 3699
3700 However, you should keep change logs for non-software files when the 3700 However, you should keep change logs for non-software files when the
3701 project gets copyright assignments from its contributors, so as to 3701 project gets copyright assignments from its contributors, so as to
3702 make the records of authorship more accurate. 3702 make the records of authorship more accurate.
3703 3703