standards: Simple Changes
1
1 6.8.3 Simple Changes
1 --------------------
1
1 Certain simple kinds of changes don't need much detail in the change
1 log.
1
1 When you change the calling sequence of a function in a simple
1 fashion, and you change all the callers of the function to use the new
1 calling sequence, there is no need to make individual entries for all
1 the callers that you changed. Just write in the entry for the function
1 being called, "All callers changed"--like this:
1
1 * keyboard.c (Fcommand_execute): New arg SPECIAL.
1 All callers changed.
1
1 When you change just comments or doc strings, it is enough to write
1 an entry for the file, without mentioning the functions. Just "Doc
1 fixes" is enough for the change log.
1
1 There's no technical need to make change log entries for
1 documentation files. This is because documentation is not susceptible
1 to bugs that are hard to fix. Documentation does not consist of parts
1 that must interact in a precisely engineered fashion. To correct an
1 error, you need not know the history of the erroneous passage; it is
1 enough to compare what the documentation says with the way the program
1 actually works.
1
1 However, you should keep change logs for documentation files when the
1 project gets copyright assignments from its contributors, so as to make
1 the records of authorship more accurate.
1