annotate admin/notes/years @ 75345:04d493c77655

*** empty log message ***
author Glenn Morris <rgm@gnu.org>
date Sun, 21 Jan 2007 01:16:03 +0000
parents eb388ac3f2f1
children 4fca1052121f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
64680
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
1 How to Maintain Copyright Years for GNU Emacs
62697
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
64680
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
4 "Our lawyer says it is ok if we add, to each file that has been in Emacs
75251
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
5 since Emacs 21 came out in 2001, all the subsequent years[1]. We don't
64680
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
6 need to check whether *that file* was changed in those years.
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
7 It's sufficient that *Emacs* was changed in those years (and it was!).
62697
344e02ca2730 *** empty log message ***
Kim F. Storm <storm@cua.dk>
parents: 62464
diff changeset
8
64680
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
9 For those files that have been added since then, we should add
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
10 the year it was added to Emacs, and all subsequent years."
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
11
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
12 --RMS, 2005-07-13
62697
344e02ca2730 *** empty log message ***
Kim F. Storm <storm@cua.dk>
parents: 62464
diff changeset
13
75251
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
14 [1] Note that this includes 2001 - see
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
15 <http://lists.gnu.org/archive/html/emacs-pretest-bug/2006-12/msg00119.html>
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
16
62697
344e02ca2730 *** empty log message ***
Kim F. Storm <storm@cua.dk>
parents: 62464
diff changeset
17
65217
c062f0fb51ba Mention rendered/commented copyright notice practice
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64680
diff changeset
18 For the refcards under etc/, it's ok to simply use the latest year
c062f0fb51ba Mention rendered/commented copyright notice practice
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64680
diff changeset
19 (typically in a `\def\year{YEAR}' expression) for the rendered copyright
c062f0fb51ba Mention rendered/commented copyright notice practice
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64680
diff changeset
20 notice, while maintaining the full list of years in the copyright notice
c062f0fb51ba Mention rendered/commented copyright notice practice
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64680
diff changeset
21 in the comments.
c062f0fb51ba Mention rendered/commented copyright notice practice
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64680
diff changeset
22
c062f0fb51ba Mention rendered/commented copyright notice practice
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64680
diff changeset
23
75251
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
24 Please fix or report any non-trivial files that have "odd" copyright
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
25 notices. This includes missing copyright notices, and copyright
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
26 holders other than FSF (or AIST in some cases). In most cases,
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
27 individual authors should not appear in copyright statements. Either
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
28 the copyright has been assigned (check copyright.list) to the FSF (in
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
29 which case the original author should be removed and the year(s)
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
30 transferred to the FSF); or else it is possible the file should not be
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
31 in Emacs at all (please report!).
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
32
75344
eb388ac3f2f1 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 75251
diff changeset
33 When updating the copyright in a file (eg a .tex file) that generates
eb388ac3f2f1 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 75251
diff changeset
34 another file distributed with Emacs, don't forget to check in a
eb388ac3f2f1 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 75251
diff changeset
35 regenerated version of the target file.
75251
f3a5f0fb3297 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 65217
diff changeset
36
75345
04d493c77655 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 75344
diff changeset
37 For auto-generated files (eg ldefs-boot.el), RMS says (20061211,
04d493c77655 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 75344
diff changeset
38 private mail): "Since they are automatically generated, it doesn't
04d493c77655 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 75344
diff changeset
39 really matter what they say."
04d493c77655 *** empty log message ***
Glenn Morris <rgm@gnu.org>
parents: 75344
diff changeset
40
64680
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
41 ------------------------------------------------------------------------------
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
42
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
43
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
44 Following is the policy that we tried to write down one time (mid 2005).
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
45 Although it is incorrect, we keep it around to remind us how complicated
32b32ccdedc0 Update. Include emacs-devel message fragment.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62697
diff changeset
46 things used to be (and may become in the future).
62464
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
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
49 Principle: Individual files need to have the year of the release
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
50 in the copyright notice if there is significant change.
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
51
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
52
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
53 Practice:
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
54
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
55 - individual files
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
56 - each must be examined, along w/ its history, by a human
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
57 - automated tools facilitate but can never replace this process
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
58
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
59 - year of the release
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
60 - may be different from year of file introduction,
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
61 or year of last significant change
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
62 - sometimes the release year slips, leaving a file w/ prematurely
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
63 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
64 - intervening years (between releases) are not valid and may cause
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
65 embarrassment later in case of dispute => remove (however, see next)
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
66 - years for new files (merged, contributed) that have been separately
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
67 published are valid even if between releases => leave alone
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
68
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
69 - significant change
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
70 - insignificant
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
71 - whitespace
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
72 - copyright notice
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
73 - version control tags
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
74 - simple var/func renaming
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
75 - in-file reorganization/reordering
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
76 - typos
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
77 - small bugfixes
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
78 - small docfixes
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
79 - filename renaming
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
80 - most everything else is significant
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
81 - change to interface
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
82 - change in functionality
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
83 - new file
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
84 - many small changes may be significant in aggregate
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
85
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
86 - when in doubt, ask (and update these guidelines -- thanks!)
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
87
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
88 - sometimes people make mistakes
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
89 - if they have not read these guidelines, point them here
fc472d032079 Initial revision
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
diff changeset
90 - if the guidelines are not helpful, improve the guidelines