Merge changes from emacs-23 branch
[bpt/emacs.git] / admin / notes / bzr
index 11f0af1..5600c9b 100644 (file)
@@ -65,15 +65,22 @@ removes a file, then remove the corresponding files by hand.
 The following description uses bound branches, presumably it works in
 a similar way with unbound ones.
 
-0) (First time only) Get the bzr changelog_merge plugin:
+0) (First time only) Get the bzr changelog_merge plugin
+(this will be included by default in bzr 2.4 onwards):
 
 cd ~/.bazaar/plugins
-bzr branch lp:bzr-changelog-merge
+# The following is an improved version of: lp:bzr-changelog-merge
+bzr branch lp:~spiv/bzr-changelog-merge/non-head-edits-723968
 mv bzr-changelog-merge changelog_merge
 
-This will make merging ChangeLogs a lot smoother.  It merges new
-entries to the top of the file, rather than trying to fit them in
-mid-way through.
+This should make merging ChangeLogs smoother.  It merges new entries
+to the top of the file, rather than trying to fit them in mid-way
+through.  Newer versions of the plugin should also be able to deal
+with changes to *old* ChangeLog entries, that should not be floated to
+the head of the file (see launchpad#723968).
+
+Maybe the default Emacs behavior without this plugin is better,
+though, it's not clear yet.
 
 1) Get clean, up-to-date copies of the emacs-23 and trunk branches.
 Check for any uncommitted changes with bzr status.
@@ -112,9 +119,17 @@ and is due to a technical limitation of bzr.  The log data for those
 revisions gets merged, the actual changes themselves do not.
 http://lists.gnu.org/archive/html/emacs-devel/2011-01/msg00609.html )
 
-Note that ChangeLog entries are automatically merged to the top with
-today's date, but you still might want to check them to see that too
-much is not being included, or whitespace between entries is not missing.
+In particular, check the ChangeLog entries (eg in case too many
+entries have been included or whitespace between entries needs fixing).
+bzrmerge tries to fix up the dates to today's date, but it only does
+this where there are conflicts.  If you used the changelog_merge plugin,
+there won't be any conflicts, and (at time of writing) you will need
+to adjust dates by hand.  In any case, if someone made multiple
+ChangeLog entries on different days in the branch, you may wish to
+collapse them all to a single entry for that author in the trunk
+(because in the trunk they all appear under the same date).
+Obviously, if there are multiple changes to the same file by different
+authors, don't break the logical ordering in doing this.
 
 Notes: