Mercurial > emacs
annotate admin/notes/commits @ 107273:d049b1b866d4
Merge from mainline.
author | Katsumi Yamaoka <yamaoka@jpl.org> |
---|---|
date | Mon, 08 Feb 2010 22:13:26 +0000 |
parents | 68e28bd7d00a |
children | 4e1df9366cdd |
rev | line source |
---|---|
106868
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
1 HOW TO COMMIT CHANGES TO EMACS |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
2 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
3 http://lists.gnu.org/archive/html/emacs-devel/2009-03/msg00555.html |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
4 From: Miles Bader |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
5 Subject: commit style redux |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
6 Date: Tue, 31 Mar 2009 12:21:20 +0900 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
7 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
8 (1) Commit all changed files at once with a single log message (which |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
9 in CVS will result in an identical log message for all committed |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
10 files), not one-by-one. This is pretty easy using vc-dir now. |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
11 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
12 (2) Make the log message describe the entire changeset, perhaps |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
13 including relevant changelog entiries (I often don't bother with |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
14 the latter if it's a trivial sort of change). |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
15 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
16 Many modern source-control systems vaguely distinguish the first |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
17 line of the log message to use as a short summary for abbreviated |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
18 history listing (in arch this was explicitly called the summary, |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
19 but many other systems have a similar concept). So it's nice if |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
20 you can format the log entry like: |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
21 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
22 SHORTISH ONE-LINE SUMMARY |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
23 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
24 MULTIPLE-LINE DETAILED DESCRIPTION POSSIBLY INCLUDING (OR |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
25 CONSISTING OF) CHANGELOG ENTRIES |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
26 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
27 [Even with CVS this style is useful, because web CVS browsing |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
28 interfaces often include the first N words of the log message of |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
29 the most recent commit as a short "most recent change" |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
30 description.] |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
31 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
32 (3) Don't phrase log messages assuming the filename is known, because |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
33 in non-file-oriented systems (everything modern other than CVS), |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
34 the log listing tends to be treated as global information, and the |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
35 connection with specific files is less explicit. |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
36 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
37 For instance, currently I often see log messages like "Regenerate"; |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
38 for modern source-control systems with a global log, it's better to |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
39 have something like "Regenerate configure". |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
40 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
41 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
42 Followup discussion: |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
43 http://lists.gnu.org/archive/html/emacs-devel/2010-01/msg00897.html |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
44 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
45 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
46 PREVIOUS GUIDELINES FOR CVS |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
47 |
a3ab0fab30ae
Update with Miles's advice on how to commit.
Glenn Morris <rgm@gnu.org>
parents:
106866
diff
changeset
|
48 For historical interest only, here is the old-style advice for CVS logs: |
92045 | 49 http://lists.gnu.org/archive/html/emacs-devel/2007-12/msg01208.html |
50 | |
51 From: Eli Zaretskii | |
52 Subject: Re: Log messages in CVS | |
53 Date: Sat, 29 Dec 2007 16:06:29 +0200 |