bzr log documentation is misleading
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Bazaar |
Confirmed
|
Medium
|
Unassigned |
Bug Description
From bug #474807:
"The doc is misleading as you well know if you followed this bug."
That is one thing which I would like to be improved. I had the impression that the real behaviour of "bzr log -rX..Y" is not well explained in "bzr help log", and reading your words confirms it, so I would like to ask: could the documentation be fixed?
I think it's this text which you are describing as misleading:
When logging a range of revisions using -rX..Y, log starts at
revision Y and searches back in history through the primary
("left-hand") parents until it finds X. When logging just the
top level (using -n1), an error is reported if X is not found
along the way. If multi-level logging is used (-n0), X may be
a nested merge revision and the log will be truncated accordingly.
I would try to express that what happens is that the full log is created (or maybe not but it feels like it for the user) and then a simple "interval filtering" is applied to it). The details about -n1 and -n0 are important to keep (maybe rephrased).
If the doc was changed, it would at least help me explain to people how the command is not doing what they expect; it would decrease the amount of confused people in the future. Thanks for considering this.
Changed in bzr: | |
status: | New → Confirmed |
importance: | Undecided → Medium |
tags: | added: doc mysql |
tags: | added: check-for-breezy |