Merge lp:~gagern/bzr/bug869912-log-root-dir into lp:bzr

[Martin von Gagern]

Allow "bzr log dir" to filter on path even if dir names a branch root.

Make "bzr log dir" filter for the given directory even if it is the root directory of its branch. Important for split branches. Use "bzr log -d dir" for old behaviour of listing the complete history of a given branch.

[Jelmer Vernooij (jelmer)]

This has a performance impact for e.g. "bzr log ~/src/bzr/bzr.dev". It would be interesting to know how big that impact is.

Presumably "bzr log" inside of a branch would still show the entire history and "bzr log ." would only show that for the current root. Can you add tests for those as well?

[Martin von Gagern (gagern)]

Performance impact is highly significant, you don't want to run "bzr log bzr.dev" using the current r6202 state of this branch. So there are basically three solutions, I believe:

1. Don't suggest that command. Get users to type "bzr log -d bzr.dev" instead. I fear users might respond to this in a rather negative way, though.

2. Add some kind of optimization. While walking the history, as long as the specified directory is the root directory, don't do any filtering. Correctly mixing this optimized unfiltered logging with slow filtered logging in the presence of split/join might be tricky, though.

An even better solution would be some general performance improvement for filtered logging. After all, there could theoretically be projects the size of bzr.dev contained in some directories of even larger projects, so filtering by subdir on that scale might be desirable. Have you ever discussed possibilities for this? How do other dvcs handle such requests?

[lp:~gagern/bzr/bug869912-log-root-dir]

6203. By Martin von Gagern on 2011-10-17

Add blackbox test for full and root-dir log in current working directory.

[Martin von Gagern (gagern)]

To talk figures: log of bzr.dev took 1.5s with -d, but 300s without it, which amounts to a factor 200 slow down. :-(

[Martin Packman (gz)]

> To talk figures: log of bzr.dev took 1.5s with -d, but 300s without it, which
> amounts to a factor 200 slow down. :-(

Ow. I actually do this quite a bit when I don't want to cd between two locations. I imagine people who grew up in a shell have more cunning methods.

[Martin Pool (mbp)]

We can't really merge this as it is given the performance impact, but I would like there to be a way to do this.

One cheap way would be to just add an option that says to follow the previous history of the root.

Perhaps there is a better way to detect it. Making log filtered by ids faster would be well worth while too, but it's unlikely to ever have zero cost.

I'm going to bump this out of the review queue for now but please do ask if you want to talk more about how to solve it.

Unmerged revisions

6203. By Martin von Gagern on 2011-10-17

Add blackbox test for full and root-dir log in current working directory.

6202. By Martin von Gagern on 2011-10-07

Fix typo and improve language.

6201. By Martin von Gagern on 2011-10-07

Document fix for #869912.

6200. By Martin von Gagern on 2011-10-07

Make use of quiet subdir creation.

6199. By Martin von Gagern on 2011-10-07

Merge from bug869915-mkdir-quiet

6198. By Martin von Gagern on 2011-10-07

Merge from bzr.dev

6197. By Martin von Gagern on 2011-10-07

Removed one more special case handling of root directory.

6196. By Martin von Gagern on 2011-10-07

Always pass listed directories in file_ids, even for root directory.
Add support for the --directory option to bzr log.
Currently the filtering by root directory still does not work as intended.

6195. By Martin von Gagern on 2011-10-07

Forgot to commit after split

6194. By Martin von Gagern on 2011-10-07

Add blackbox test case for bug #869912.

=== modified file 'bzrlib/builtins.py'
--- bzrlib/builtins.py	2011-10-14 13:56:45 +0000
+++ bzrlib/builtins.py	2011-10-17 12:24:37 +0000
@@ -2465,6 +2465,7 @@
     takes_args = ['file*']
     _see_also = ['log-formats', 'revisionspec']
     takes_options = [
+            'directory',
             Option('forward',
                    help='Show from oldest to newest.'),
             'timezone',
@@ -2559,6 +2560,7 @@
             match_author=None,
             match_bugs=None,
             omit_merges=False,
+            directory=None,
             include_merges=symbol_versioning.DEPRECATED_PARAMETER,
             ):
         from bzrlib.log import (
@@ -2615,12 +2617,7 @@
                     raise errors.BzrCommandError(gettext(
                         "Path unknown at end or start of revision range: %s") %
                         relpath)
-                # If the relpath is the top of the tree, we log everything
-                if relpath == '':
-                    file_ids = []
-                    break
-                else:
-                    file_ids.append(file_id)
+                file_ids.append(file_id)
                 filter_by_dir = filter_by_dir or (
                     kind in ['directory', 'tree-reference'])
         else:
@@ -2629,6 +2626,8 @@
             if revision is not None \
                     and len(revision) > 0 and revision[0].get_branch():
                 location = revision[0].get_branch()
+            elif directory is not None:
+                location = directory
             else:
                 location = '.'
             dir, relpath = controldir.ControlDir.open_containing(location)

=== modified file 'bzrlib/log.py'
--- bzrlib/log.py	2011-10-14 13:56:45 +0000
+++ bzrlib/log.py	2011-10-17 12:24:37 +0000
@@ -2047,8 +2047,6 @@
     info_list = []
     start_rev_info, end_rev_info = _get_revision_range(revisionspec_list, b,
         "log")
-    if relpaths in ([], [u'']):
-        return b, [], start_rev_info, end_rev_info
     if start_rev_info is None and end_rev_info is None:
         if tree is None:
             tree = b.basis_tree()

=== modified file 'bzrlib/tests/blackbox/test_log.py'
--- bzrlib/tests/blackbox/test_log.py	2011-10-12 16:00:13 +0000
+++ bzrlib/tests/blackbox/test_log.py	2011-10-17 12:24:37 +0000
@@ -30,6 +30,7 @@
 from bzrlib.tests import (
     test_log,
     features,
+    script,
     )
 
 
@@ -1052,3 +1053,78 @@
         self.assertLogRevnos(["--match-author", "author"], ["2", "1"])
         self.assertLogRevnos(["--match-author", "author1", 
                               "--match-author", "author2"], ["2", "1"])
+
+
+class TestLogScripts(script.TestCaseWithTransportAndScript):
+
+    def test_root_of_split_branch_subdir(self):
+        self.run_script("""\
+$ bzr init -q .
+$ bzr mkdir -q sub
+$ echo foo_content > sub/foo
+$ bzr add -q sub/foo
+$ bzr commit -q -m "created sub"
+$ echo bar_content > bar
+$ bzr add -q bar
+$ bzr commit -q -m "not modifying sub"
+$ bzr split sub
+$ bzr commit -q -m "split sub from its parent" sub
+$ bzr log --log-format=line sub
+3: ... split sub from its parent
+1: ... created sub
+""")
+
+    def test_whole_history_of_split_branch_subdir(self):
+        self.run_script("""\
+$ bzr init -q .
+$ bzr mkdir -q sub
+$ echo foo_content > sub/foo
+$ bzr add -q sub/foo
+$ bzr commit -q -m "created sub"
+$ echo bar_content > bar
+$ bzr add -q bar
+$ bzr commit -q -m "not modifying sub"
+$ bzr split sub
+$ bzr commit -q -m "split sub from its parent" sub
+$ bzr log --log-format=line -d sub
+3: ... split sub from its parent
+2: ... not modifying sub
+1: ... created sub
+""")
+
+    def test_root_of_split_branch_curdir(self):
+        self.run_script("""\
+$ bzr init -q .
+$ bzr mkdir -q sub
+$ echo foo_content > sub/foo
+$ bzr add -q sub/foo
+$ bzr commit -q -m "created sub"
+$ echo bar_content > bar
+$ bzr add -q bar
+$ bzr commit -q -m "not modifying sub"
+$ bzr split sub
+$ bzr commit -q -m "split sub from its parent" sub
+$ cd sub
+$ bzr log --log-format=line .
+3: ... split sub from its parent
+1: ... created sub
+""")
+
+    def test_whole_history_of_split_branch_curdir(self):
+        self.run_script("""\
+$ bzr init -q .
+$ bzr mkdir -q sub
+$ echo foo_content > sub/foo
+$ bzr add -q sub/foo
+$ bzr commit -q -m "created sub"
+$ echo bar_content > bar
+$ bzr add -q bar
+$ bzr commit -q -m "not modifying sub"
+$ bzr split sub
+$ bzr commit -q -m "split sub from its parent" sub
+$ cd sub
+$ bzr log --log-format=line
+3: ... split sub from its parent
+2: ... not modifying sub
+1: ... created sub
+""")

=== modified file 'doc/en/release-notes/bzr-2.5.txt'
--- doc/en/release-notes/bzr-2.5.txt	2011-10-16 10:05:26 +0000
+++ doc/en/release-notes/bzr-2.5.txt	2011-10-17 12:24:37 +0000
@@ -51,10 +51,18 @@
 * ``bzr mkdir --quiet`` now does not print a line for every created
   directory. (Martin von Gagern, #869915)
 
+<<<<<<< TREE
 * ``bzr shelve`` now use ``UIFactory.choose`` for input handling, making
   it usable when creating a custom ``UIFactory`` implementation. (Benoît
   Pierre)
 
+=======
+* ``bzr log dir`` now filters for the given directory even if it is
+  the root directory of its branch. This is important for split
+  branches. Use ``bzr log -d dir`` for old behaviour of listing the
+  complete history of a given branch. (Martin von Gagern, #869912)
+
+>>>>>>> MERGE-SOURCE
 Documentation
 *************