annotate admin/notes/years @ 62697:344e02ca2730

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