annotate admin/notes/years @ 62464:fc472d032079

Initial revision
author Thien-Thi Nguyen <ttn@gnuvola.org>
date Wed, 18 May 2005 10:54:34 +0000
parents
children 344e02ca2730
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
62464
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
1 How to Maintain Copyright Years for GNU Emacs
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
2
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
3
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
4 Principle: Individual files need to have the year of the release
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
5 in the copyright notice if there is significant change.
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
6
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
7
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
8 Practice:
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
9
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
10 - individual files
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
11 - each must be examined, along w/ its history, by a human
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
12 - automated tools facilitate but can never replace this process
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
13
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
14 - year of the release
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
15 - may be different from year of file introduction,
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
16 or year of last significant change
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
17 - sometimes the release year slips, leaving a file w/ prematurely
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
18 marked release year => need update (e.g., s/2004/2005/ for Emacs 22)
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
19 - intervening years (between releases) are not valid and may cause
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
20 embarrassment later in case of dispute => remove (however, see next)
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
21 - years for new files (merged, contributed) that have been separately
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
22 published are valid even if between releases => leave alone
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
23
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
24 - significant change
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
25 - insignificant
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
26 - whitespace
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
27 - copyright notice
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
28 - version control tags
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
29 - simple var/func renaming
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
30 - in-file reorganization/reordering
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
31 - typos
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
32 - small bugfixes
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
33 - small docfixes
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
34 - filename renaming
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
35 - most everything else is significant
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
36 - change to interface
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
37 - change in functionality
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
38 - new file
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
39 - many small changes may be significant in aggregate
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
40
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
41 - when in doubt, ask (and update these guidelines -- thanks!)
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
42
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
43 - sometimes people make mistakes
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
44 - if they have not read these guidelines, point them here
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
45 - if the guidelines are not helpful, improve the guidelines