aboutsummaryrefslogtreecommitdiffstats
path: root/admin/notes
diff options
context:
space:
mode:
authorJan D2015-04-26 13:55:01 +0200
committerJan D2015-04-26 13:55:01 +0200
commitf92ac2e82ed199d6f25d2a59508e08addb1150ac (patch)
treed7d7756e3dbce10d8f73c27815d815499f78c2bd /admin/notes
parent5a094119ce79723108abd90a1fcc33721e964823 (diff)
parenta40869789fc5502e3d4e393b7c31d78cb7f29aa1 (diff)
downloademacs-f92ac2e82ed199d6f25d2a59508e08addb1150ac.tar.gz
emacs-f92ac2e82ed199d6f25d2a59508e08addb1150ac.zip
Merge branch 'master' into cairo
Diffstat (limited to 'admin/notes')
-rw-r--r--admin/notes/repo54
1 files changed, 32 insertions, 22 deletions
diff --git a/admin/notes/repo b/admin/notes/repo
index 4f9dc59eb0f..f38fd2cc3a8 100644
--- a/admin/notes/repo
+++ b/admin/notes/repo
@@ -10,10 +10,10 @@ instructions.
10* Install changes only on one branch, let them get merged elsewhere if needed. 10* Install changes only on one branch, let them get merged elsewhere if needed.
11 11
12In particular, install bug-fixes only on the release branch (if there 12In particular, install bug-fixes only on the release branch (if there
13is one) and let them get synced to the trunk; do not install them by 13is one) and let them get synced to the master; do not install them by
14hand on the trunk as well. E.g. if there is an active "emacs-24" branch 14hand on the master as well. E.g. if there is an active "emacs-24" branch
15and you have a bug-fix appropriate for the next emacs-24.x release, 15and you have a bug-fix appropriate for the next emacs-24.x release,
16install it only on the emacs-24 branch, not on the trunk as well. 16install it only on the emacs-24 branch, not on the master as well.
17 17
18Installing things manually into more than one branch makes merges more 18Installing things manually into more than one branch makes merges more
19difficult. 19difficult.
@@ -21,10 +21,10 @@ difficult.
21http://lists.gnu.org/archive/html/emacs-devel/2010-03/msg01124.html 21http://lists.gnu.org/archive/html/emacs-devel/2010-03/msg01124.html
22 22
23The exception is, if you know that the change will be difficult to 23The exception is, if you know that the change will be difficult to
24merge to the trunk (eg because the trunk code has changed a lot). 24merge to the master (eg because the master code has changed a lot).
25In that case, it's helpful if you can apply the change to both trunk 25In that case, it's helpful if you can apply the change to both master
26and branch yourself (when committing the branch change, indicate 26and branch yourself (when committing the branch change, indicate
27in the commit log that it should not be merged to the trunk, by 27in the commit log that it should not be merged to the master, by
28including the phrase "Not to be merged to master", or any other phrase 28including the phrase "Not to be merged to master", or any other phrase
29that matches "merge"). 29that matches "merge").
30 30
@@ -32,14 +32,14 @@ that matches "merge").
32 32
33If your branch has only a single commit, or many different real 33If your branch has only a single commit, or many different real
34commits, it is fine to do a merge. If your branch has only a very 34commits, it is fine to do a merge. If your branch has only a very
35small number of "real" commits, but several "merge from trunks", it is 35small number of "real" commits, but several "merge from masters", it is
36preferred that you take your branch's diff, apply it to the trunk, and 36preferred that you take your branch's diff, apply it to the master, and
37commit directly, not merge. This keeps the history cleaner. 37commit directly, not merge. This keeps the history cleaner.
38 38
39In general, when working on some feature in a separate branch, it is 39In general, when working on some feature in a separate branch, it is
40preferable not to merge from trunk until you are done with the 40preferable not to merge from master until you are done with the
41feature. Unless you really need some change that was done on the 41feature. Unless you really need some change that was done on the
42trunk while you were developing on the branch, you don't really need 42master while you were developing on the branch, you don't really need
43those merges; just merge once, when you are done with the feature, and 43those merges; just merge once, when you are done with the feature, and
44Bazaar will take care of the rest. Bazaar is much better in this than 44Bazaar will take care of the rest. Bazaar is much better in this than
45CVS, so interim merges are unnecessary. 45CVS, so interim merges are unnecessary.
@@ -66,22 +66,14 @@ variable in admin/merge-gnulib before running it.
66If you remove a gnulib module, or if a gnulib module 66If you remove a gnulib module, or if a gnulib module
67removes a file, then remove the corresponding files by hand. 67removes a file, then remove the corresponding files by hand.
68 68
69* How to merge changes from emacs-24 to trunk 69* How to merge changes from emacs-24 to master
70 70
71[The section on git merge procedure has not yet been written] 71[The section on git merge procedure has not yet been written.]
72
73Inspect the change log entries (e.g. in case too many entries have been
74included or whitespace between entries needs fixing). If someone made
75multiple change log entries on different days in the branch, you may
76wish to collapse them all to a single entry for that author in the
77trunk (because in the trunk they all appear under the same date).
78Obviously, if there are multiple changes to the same file by different
79authors, don't break the logical ordering in doing this.
80 72
81You may see conflicts in autoload md5sums in comments. Strictly 73You may see conflicts in autoload md5sums in comments. Strictly
82speaking, the right thing to do is merge everything else, resolve the 74speaking, the right thing to do is merge everything else, resolve the
83conflict by choosing either the trunk or branch version, then run 75conflict by choosing either the master or branch version, then run
84`make -C lisp autoloads' to update the md5sums to the correct trunk 76`make -C lisp autoloads' to update the md5sums to the correct master
85value before committing. 77value before committing.
86 78
87* Re-adding a file that has been removed from the repository 79* Re-adding a file that has been removed from the repository
@@ -124,3 +116,21 @@ again.
124 116
125This is a semi-automated way to find the revision that introduced a bug. 117This is a semi-automated way to find the revision that introduced a bug.
126Browse `git help bisect' for technical instructions. 118Browse `git help bisect' for technical instructions.
119
120* Maintaining ChangeLog history
121
122Older ChangeLog entries are kept in history files named ChangeLog.1,
123ChangeLog.2, etc., and can be edited just as any other source files
124can. Newer ChangeLog entries are stored in the repository as commit
125messages, which cannot be edited directly.
126
127'make ChangeLog' copies newer ChangeLog entries into a file
128'ChangeLog' that is intended to be put into the distribution tarball.
129This ChangeLog file is not put into the repository.
130
131'make change-history' copies all newer ChangeLog entries into the
132start of the newest ChangeLog history file. These ChangeLog entries
133are thereafter considered to be old, so later uses of 'make ChangeLog'
134and/or 'make change-history' will no longer copy the entries. To
135alter ChangeLog history, run 'make change-history', then edit
136the ChangeLog history files manually and commit your changes.