public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox•com>
To: git@vger•kernel.org
Cc: Martin von Zweigbergk <martin.von.zweigbergk@gmail•com>
Subject: [PATCH] rev-list docs: clarify --topo-order description
Date: Mon, 13 Aug 2012 15:21:09 -0700	[thread overview]
Message-ID: <7vsjbqbfhm.fsf@alter.siamese.dyndns.org> (raw)

We said "--date-order" still does not violate the topology, but it
was still not clear enough.

Reword the description for both "--date-order" and "--topo-order",
and add an illustration to it.

Signed-off-by: Junio C Hamano <gitster@pobox•com>
---

 * Let's do this before I forget...; came up in discussion $gmane/203370

 Documentation/rev-list-options.txt | 29 +++++++++++++++++++++++------
 1 file changed, 23 insertions(+), 6 deletions(-)

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 6a4b635..dc501ee 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -579,15 +579,32 @@ Commit Ordering
 By default, the commits are shown in reverse chronological order.
 
 --topo-order::
-
-	This option makes them appear in topological order (i.e.
-	descendant commits are shown before their parents).
+	This option makes them appear in topological order.  Even
+	without this option, descendant commits are shown before
+	their parents, but this tries to avoid showing commits on
+	multiple lines of history intermixed.
 
 --date-order::
 
-	This option is similar to '--topo-order' in the sense that no
-	parent comes before all of its children, but otherwise things
-	are still ordered in the commit timestamp order.
+	Show no parents before all of its children, but otherwise
+	show commits in the commit timestamp order.
++
+For example, in a commit history like this:
++
+----------------------------------------------------------------
+
+    ---1----2----4----7
+	\	       \
+	 3----5----6----8---
+
+----------------------------------------------------------------
++
+where the numbers denote the order of commit timestamps, `git
+rev-list` and friends with `--date-order` show the commits in the
+timestamp order: 8 7 6 5 4 3 2 1.
++
+With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5
+3 1), to avoid commits from two branches mixed together.
 
 --reverse::
 
-- 
1.7.12.rc2.85.g1de7134

             reply	other threads:[~2012-08-13 22:21 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-08-13 22:21 Junio C Hamano [this message]
2012-08-13 22:46 ` [PATCH] rev-list docs: clarify --topo-order description Martin von Zweigbergk
2012-08-13 23:05   ` Junio C Hamano
2012-08-14  5:33     ` Martin von Zweigbergk
2012-08-14 14:54       ` Junio C Hamano
2012-08-14  8:22 ` Michael Haggerty
2012-08-14  8:45 ` Thomas Rast
2012-08-14 14:30   ` Junio C Hamano
2012-08-14 14:51     ` Thomas Rast
2012-08-14 15:47       ` Junio C Hamano
2012-08-15 20:02       ` [PATCH v2] " Junio C Hamano
2012-08-16  6:06         ` Martin von Zweigbergk
2012-08-16  6:20           ` Junio C Hamano
2012-08-16  6:26             ` Junio C Hamano
2012-08-16  8:51               ` Thomas Rast
2012-08-16 10:01                 ` Michael Haggerty
2012-08-16 12:00                   ` Thomas Rast
2012-08-16 16:10                     ` Junio C Hamano
2012-08-17  9:34                       ` Thomas Rast
2012-08-17  9:50                         ` Thomas Rast
2012-08-17 17:18                         ` Junio C Hamano
2012-08-17 17:37                           ` Thomas Rast
2012-08-17 18:11                             ` Junio C Hamano
2012-08-17 17:40                         ` Junio C Hamano
2012-08-16 16:35                     ` Michael Haggerty
2012-08-16  8:42         ` Thomas Rast

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7vsjbqbfhm.fsf@alter.siamese.dyndns.org \
    --to=gitster@pobox$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=martin.von.zweigbergk@gmail$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox