summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorPetr Baudis <pasky@ucw.cz>2005-06-08 20:59:43 (GMT)
committerLinus Torvalds <torvalds@ppc970.osdl.org>2005-06-08 22:59:09 (GMT)
commit17ebe977d72290dcdc848b78ae2e65b59d4e1b4c (patch)
tree9fbebb601c1278af419e3dc38286df3acab9ea83 /Documentation
parentf225b21807a5f6ac589132e4d004e78038d23375 (diff)
downloadgit-17ebe977d72290dcdc848b78ae2e65b59d4e1b4c.zip
git-17ebe977d72290dcdc848b78ae2e65b59d4e1b4c.tar.gz
git-17ebe977d72290dcdc848b78ae2e65b59d4e1b4c.tar.bz2
[PATCH] Tidy up some rev-list-related stuff
This patch tidies up the git-rev-list documentation and epoch.c, which are in severe clash with the unwritten coding style now, and quite unreadable. It also fixes up compile failures with older compilers due to variable declarations after code. The patch mostly wraps lines before or on the 80th column, removes plenty of superfluous empty lines and changes comments from // to /* */. Signed-off-by: Petr Baudis <pasky@ucw.cz> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-rev-list.txt51
1 files changed, 33 insertions, 18 deletions
diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index 3cfa58b..fe86c9c 100644
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -17,30 +17,45 @@ Lists commit objects in reverse chronological order starting at the
given commit, taking ancestry relationship into account. This is
useful to produce human-readable log output.
-If *--merge-order* is specified, the commit history is decomposed into a unique sequence of minimal, non-linear
-epochs and maximal, linear epochs. Non-linear epochs are then linearised by sorting them into merge order, which
+If *--merge-order* is specified, the commit history is decomposed into a
+unique sequence of minimal, non-linear epochs and maximal, linear epochs.
+Non-linear epochs are then linearised by sorting them into merge order, which
is described below.
-Maximal, linear epochs correspond to periods of sequential development. Minimal, non-linear epochs
-correspond to periods of divergent development followed by a converging merge. The theory of epochs is described
-in more detail at link:http://blackcubes.dyndns.org/epoch/[http://blackcubes.dyndns.org/epoch/].
+Maximal, linear epochs correspond to periods of sequential development.
+Minimal, non-linear epochs correspond to periods of divergent development
+followed by a converging merge. The theory of epochs is described in more
+detail at
+link:http://blackcubes.dyndns.org/epoch/[http://blackcubes.dyndns.org/epoch/].
-The merge order for a non-linear epoch is defined as a linearisation for which the following invariants are true:
+The merge order for a non-linear epoch is defined as a linearisation for which
+the following invariants are true:
- 1. if a commit P is reachable from commit N, commit P sorts after commit N in the linearised list.
- 2. if Pi and Pj are any two parents of a merge M (with i < j), then any commit N, such that N is reachable from Pj
- but not reachable from Pi, sorts before all commits reachable from Pi.
-
-Invariant 1 states that later commits appear before earlier commits they are derived from.
+ 1. if a commit P is reachable from commit N, commit P sorts after commit N
+ in the linearised list.
+ 2. if Pi and Pj are any two parents of a merge M (with i < j), then any
+ commit N, such that N is reachable from Pj but not reachable from Pi,
+ sorts before all commits reachable from Pi.
-Invariant 2 states that commits unique to "later" parents in a merge, appear before all commits from "earlier" parents of
-a merge.
+Invariant 1 states that later commits appear before earlier commits they are
+derived from.
-If *--show-breaks* is specified, each item of the list is output with a 2-character prefix consisting of one of:
- (|), (^), (=) followed by a space.
-Commits marked with (=) represent the boundaries of minimal, non-linear epochs and correspond either to the start of a period of divergent development or to the end of such a period.
-Commits marked with (|) are direct parents of commits immediately preceding the marked commit in the list.
-Commits marked with (^) are not parents of the immediately preceding commit. These "breaks" represent necessary discontinuities implied by trying to represent an arbtirary DAG in a linear form.
+Invariant 2 states that commits unique to "later" parents in a merge, appear
+before all commits from "earlier" parents of a merge.
+
+If *--show-breaks* is specified, each item of the list is output with a
+2-character prefix consisting of one of: (|), (^), (=) followed by a space.
+
+Commits marked with (=) represent the boundaries of minimal, non-linear epochs
+and correspond either to the start of a period of divergent development or to
+the end of such a period.
+
+Commits marked with (|) are direct parents of commits immediately preceding
+the marked commit in the list.
+
+Commits marked with (^) are not parents of the immediately preceding commit.
+These "breaks" represent necessary discontinuities implied by trying to
+represent an arbtirary DAG in a linear form.
*--show-breaks* is only valid if *--merge-order* is also specified.