aboutsummaryrefslogtreecommitdiffstats
path: root/admin
diff options
context:
space:
mode:
authorKenichi Handa2010-01-18 10:07:25 +0900
committerKenichi Handa2010-01-18 10:07:25 +0900
commitb7235808116742ec0a7aacbe53fb80db13ce5ef7 (patch)
treede1a69bba2232b000b9166c3f9accc3f9672c1fa /admin
parentf0d138880a572e2b064d5af2668cd3a54a1d0a1e (diff)
parentf53a65903cdb66a73b919617054a69ce8042e495 (diff)
downloademacs-b7235808116742ec0a7aacbe53fb80db13ce5ef7.tar.gz
emacs-b7235808116742ec0a7aacbe53fb80db13ce5ef7.zip
Add bug number.
Diffstat (limited to 'admin')
-rw-r--r--admin/notes/BRANCH7
-rw-r--r--admin/notes/commits53
-rw-r--r--admin/notes/copyright28
-rw-r--r--admin/notes/cvslogs15
4 files changed, 70 insertions, 33 deletions
diff --git a/admin/notes/BRANCH b/admin/notes/BRANCH
index 863d86a1ed9..258fcd95566 100644
--- a/admin/notes/BRANCH
+++ b/admin/notes/BRANCH
@@ -1,11 +1,10 @@
1This file describes the CVS branch in which it is maintained. 1This file describes the bzr branch in which it is maintained.
2Everything below the line is branch-specific. 2Everything below the line is branch-specific.
3________________________________________________________________________ 3________________________________________________________________________
4 4
5This is the trunk (sometimes mistakenly called "HEAD"). 5This is the trunk (sometimes mistakenly called "HEAD").
6When people say "use CVS emacs", this is the branch they are talking 6When people say "use the development version of Emacs" or the
7about. Likewise, a "cvs checkout" without the "-r" option results in 7"bzr version of Emacs", this is the branch they are talking about.
8this branch.
9 8
10Emacs development takes place on the trunk. Most of the time, Emacs 9Emacs development takes place on the trunk. Most of the time, Emacs
11hackers add to it relatively free of constraint (aside from proper 10hackers add to it relatively free of constraint (aside from proper
diff --git a/admin/notes/commits b/admin/notes/commits
new file mode 100644
index 00000000000..2896328c664
--- /dev/null
+++ b/admin/notes/commits
@@ -0,0 +1,53 @@
1HOW TO COMMIT CHANGES TO EMACS
2
3http://lists.gnu.org/archive/html/emacs-devel/2009-03/msg00555.html
4From: Miles Bader
5Subject: commit style redux
6Date: Tue, 31 Mar 2009 12:21:20 +0900
7
8(1) Commit all changed files at once with a single log message (which
9 in CVS will result in an identical log message for all committed
10 files), not one-by-one. This is pretty easy using vc-dir now.
11
12(2) Make the log message describe the entire changeset, perhaps
13 including relevant changelog entiries (I often don't bother with
14 the latter if it's a trivial sort of change).
15
16 Many modern source-control systems vaguely distinguish the first
17 line of the log message to use as a short summary for abbreviated
18 history listing (in arch this was explicitly called the summary,
19 but many other systems have a similar concept). So it's nice if
20 you can format the log entry like:
21
22 SHORTISH ONE-LINE SUMMARY
23
24 MULTIPLE-LINE DETAILED DESCRIPTION POSSIBLY INCLUDING (OR
25 CONSISTING OF) CHANGELOG ENTRIES
26
27 [Even with CVS this style is useful, because web CVS browsing
28 interfaces often include the first N words of the log message of
29 the most recent commit as a short "most recent change"
30 description.]
31
32(3) Don't phrase log messages assuming the filename is known, because
33 in non-file-oriented systems (everything modern other than CVS),
34 the log listing tends to be treated as global information, and the
35 connection with specific files is less explicit.
36
37 For instance, currently I often see log messages like "Regenerate";
38 for modern source-control systems with a global log, it's better to
39 have something like "Regenerate configure".
40
41
42Followup discussion:
43http://lists.gnu.org/archive/html/emacs-devel/2010-01/msg00897.html
44
45
46PREVIOUS GUIDELINES FOR CVS
47
48For historical interest only, here is the old-style advice for CVS logs:
49http://lists.gnu.org/archive/html/emacs-devel/2007-12/msg01208.html
50
51From: Eli Zaretskii
52Subject: Re: Log messages in CVS
53Date: Sat, 29 Dec 2007 16:06:29 +0200
diff --git a/admin/notes/copyright b/admin/notes/copyright
index 40c45404f75..f4ceb273c73 100644
--- a/admin/notes/copyright
+++ b/admin/notes/copyright
@@ -24,9 +24,9 @@ the file.
24 24
252. When installing code written by someone else, the ChangeLog entry 252. When installing code written by someone else, the ChangeLog entry
26should be in the name of the author of the code, not the person who 26should be in the name of the author of the code, not the person who
27installs it. I think it is helpful to put the author (if not yourself) 27installs it. I think it is helpful to put the author (if not yourself)
28in the CVS log as well; and to not install any of your own changes in 28in the commit log as well (you can also use bzr commit's "--author"
29the same commit. 29option); and to not install any of your own changes in the same commit.
30 30
313. With images, add the legal info to a README file in the directory 313. With images, add the legal info to a README file in the directory
32containing the image. 32containing the image.
@@ -38,17 +38,17 @@ legal notices, consider if you should add a copyright statement.
38right thing to do. 38right thing to do.
39 39
40 40
41Every non-trivial file distributed through the Emacs CVS should be 41Every non-trivial file distributed through the Emacs repository should be
42self-explanatory in terms of copyright and license. This includes 42self-explanatory in terms of copyright and license. This includes
43files that are not distributed in Emacs releases (for example, the 43files that are not distributed in Emacs releases (for example, the
44admin/ directory), because the whole Emacs CVS is publicly 44admin/ directory), because the whole Emacs repository is publicly
45available. 45available.
46 46
47The definition of triviality is a little vague, but a rule of thumb is 47The definition of triviality is a little vague, but a rule of thumb is
48that any file with less than 15 lines of actual content is trivial. If 48that any file with less than 15 lines of actual content is trivial. If
49a file is auto-generated (eg ldefs-boot.el) from another one in the 49a file is auto-generated (eg ldefs-boot.el) from another one in the
50CVS, then it does not really matter about adding a copyright statement 50repository, then it does not really matter about adding a copyright
51to the generated file. 51statement to the generated file.
52 52
53Legal advice says that we could, if we wished, put a license notice 53Legal advice says that we could, if we wished, put a license notice
54even in trivial files, because copyright law in general looks at the 54even in trivial files, because copyright law in general looks at the
@@ -67,8 +67,8 @@ file "years" in this directory). The PDF versions of refcards etc
67should display copyright notices (an exception to the rule about 67should display copyright notices (an exception to the rule about
68"generated" files), but these can just display the latest year. The 68"generated" files), but these can just display the latest year. The
69full list of years should be kept in comments in the source file. If 69full list of years should be kept in comments in the source file. If
70these are distributed in CVS, check in a regenerated version when the 70these are distributed in the repository, check in a regenerated
71tex files are updated. 71version when the tex files are updated.
72 72
73Copyright changes should be propagated to any associated repositories 73Copyright changes should be propagated to any associated repositories
74(eg Gnus, MH-E), but I think in every case this happens automatically 74(eg Gnus, MH-E), but I think in every case this happens automatically
@@ -115,7 +115,7 @@ author should be removed and the year(s) transferred to the FSF); or
115else it is possible the file should not be in Emacs at all (please 115else it is possible the file should not be in Emacs at all (please
116report!). 116report!).
117 117
118Note that it seems painfully clear that one cannot rely on CVS logs, 118Note that it seems painfully clear that one cannot rely on commit logs,
119or even ChangeLogs, for older changes. People often installed changes 119or even ChangeLogs, for older changes. People often installed changes
120from others, without recording the true authorship. 120from others, without recording the true authorship.
121 121
@@ -555,10 +555,10 @@ system)
555 obviously good): 555 obviously good):
556 556
557 557
558Is it OK to just `cvs remove' a file for legal reasons, or is 558Is it OK to just `bzr remove' a file for legal reasons, or is
559something more drastic needed? A removed file is still available from 559something more drastic needed? A removed file is still available from
560CVS, if suitable options are applied. (This CVS issue obviously does 560the repository, if suitable options are applied. (This issue obviously
561not affect a release). 561does not affect a release).
562 rms: will ask lawyer 562 rms: will ask lawyer
563 563
564 564
@@ -600,7 +600,7 @@ The EMACS_22_BASE branch was changed to GPLv3 (or later) 2007/07/25.
600Some notes: 600Some notes:
601(see http://lists.gnu.org/archive/html/emacs-devel/2007-07/msg01431.html) 601(see http://lists.gnu.org/archive/html/emacs-devel/2007-07/msg01431.html)
602 602
6031. There are some files in Emacs CVS which are not part of Emacs (eg 6031. There are some files in the Emacs tree which are not part of Emacs (eg
604those included from Gnulib). These are all copyright FSF and (at time 604those included from Gnulib). These are all copyright FSF and (at time
605of writing) GPL >= 2. rms says may as well leave the licenses of these 605of writing) GPL >= 2. rms says may as well leave the licenses of these
606alone (may import them from Gnulib again). These are: 606alone (may import them from Gnulib again). These are:
diff --git a/admin/notes/cvslogs b/admin/notes/cvslogs
deleted file mode 100644
index ff2dcc93ff5..00000000000
--- a/admin/notes/cvslogs
+++ /dev/null
@@ -1,15 +0,0 @@
1http://lists.gnu.org/archive/html/emacs-devel/2007-12/msg01208.html
2
3From: Eli Zaretskii
4Subject: Re: Log messages in CVS
5Date: Sat, 29 Dec 2007 16:06:29 +0200
6
7I once posted a summary that I know about; see:
8
9 http://lists.gnu.org/archive/html/emacs-devel/2006-11/msg00229.html
10 http://lists.gnu.org/archive/html/emacs-devel/2006-11/msg00234.html
11 http://lists.gnu.org/archive/html/emacs-devel/2006-11/msg00312.html
12
13Richard commented here, basically approving my summary:
14
15 http://lists.gnu.org/archive/html/emacs-devel/2006-11/msg00276.html