git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bo Yang <struggleyb.nku@gmail.com>
To: git@vger.kernel.org
Subject: [WIP PATCH 13/22] Document line history browser
Date: Sat, 24 Jul 2010 23:13:45 +0800	[thread overview]
Message-ID: <1279984434-28933-14-git-send-email-struggleyb.nku@gmail.com> (raw)
In-Reply-To: <1279984434-28933-1-git-send-email-struggleyb.nku@gmail.com>

Both 'git log' and 'git blame' support the same format
of '-L' arguments, so we refactor its description into
a new file.

And it is possible to use more than one '-L' option
for each path.

Signed-off-by: Bo Yang <struggleyb.nku@gmail.com>
---
 Documentation/blame-options.txt     |   19 +------------------
 Documentation/git-log.txt           |   15 +++++++++++++++
 Documentation/line-range-format.txt |   18 ++++++++++++++++++
 3 files changed, 34 insertions(+), 18 deletions(-)
 create mode 100644 Documentation/line-range-format.txt

diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index 16e3c68..3526835 100644
--- a/Documentation/blame-options.txt
+++ b/Documentation/blame-options.txt
@@ -13,24 +13,7 @@
 	Annotate only the given line range.  <start> and <end> can take
 	one of these forms:
 
-	- number
-+
-If <start> or <end> is a number, it specifies an
-absolute line number (lines count from 1).
-+
-
-- /regex/
-+
-This form will use the first line matching the given
-POSIX regex.  If <end> is a regex, it will search
-starting at the line given by <start>.
-+
-
-- +offset or -offset
-+
-This is only valid for <end> and will specify a number
-of lines before or after the line given by <start>.
-+
+include::line-range-format.txt[]
 
 -l::
 	Show long rev (Default: off).
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index e970664..6f712e7 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -9,6 +9,7 @@ git-log - Show commit logs
 SYNOPSIS
 --------
 'git log' [<options>] [<since>..<until>] [[\--] <path>...]
+'git log' [<options>] -L n,m <path>
 
 DESCRIPTION
 -----------
@@ -19,6 +20,9 @@ command to control what is shown and how, and options applicable to
 the 'git diff-*' commands to control how the changes
 each commit introduces are shown.
 
+With '-L' option, the command will help to trace the history of user specified
+line ranges. It can trace multiple ranges coming from multiple files.
+
 
 OPTIONS
 -------
@@ -63,6 +67,17 @@ OPTIONS
 	Note that only message is considered, if also a diff is shown
 	its size is not included.
 
+-L <start>,<end>::
+	The line range.  <start> and <end> can take one of these forms:
+
+include::line-range-format.txt[]
+You can also specify this option more than once before each path.
+
+
+--full-line-diff::
+	Always print the interesting range even if the current commit
+	does not change any line of the range.
+
 [\--] <path>...::
 	Show only commits that affect any of the specified paths. To
 	prevent confusion with options and branch names, paths may need
diff --git a/Documentation/line-range-format.txt b/Documentation/line-range-format.txt
new file mode 100644
index 0000000..265bc23
--- /dev/null
+++ b/Documentation/line-range-format.txt
@@ -0,0 +1,18 @@
+- number
++
+If <start> or <end> is a number, it specifies an
+absolute line number (lines count from 1).
++
+
+- /regex/
++
+This form will use the first line matching the given
+POSIX regex.  If <end> is a regex, it will search
+starting at the line given by <start>.
++
+
+- +offset or -offset
++
+This is only valid for <end> and will specify a number
+of lines before or after the line given by <start>.
++
-- 
1.7.0.2.273.gc2413.dirty

  parent reply	other threads:[~2010-07-24 15:15 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-24 15:13 [WIP PATCH 00/22] Some updates since v3 Bo Yang
2010-07-24 15:13 ` [WIP PATCH 01/22] parse-options: enhance STOP_AT_NON_OPTION Bo Yang
2010-07-24 15:13 ` [WIP PATCH 02/22] parse-options: add two helper functions Bo Yang
2010-07-24 15:13 ` [WIP PATCH 03/22] Add the basic data structure for line level history Bo Yang
2010-07-24 15:13 ` [WIP PATCH 04/22] Refactor parse_loc Bo Yang
2010-07-24 15:13 ` [WIP PATCH 05/22] Parse the -L options Bo Yang
2010-07-24 15:13 ` [WIP PATCH 06/22] Export three functions from diff.c Bo Yang
2010-07-24 15:13 ` [WIP PATCH 07/22] Add range clone functions Bo Yang
2010-07-24 15:13 ` [WIP PATCH 08/22] map/take range to the parent of commits Bo Yang
2010-07-24 15:13 ` [WIP PATCH 09/22] Print the line log Bo Yang
2010-07-24 15:13 ` [WIP PATCH 10/22] Hook line history into cmd_log, ensuring a topo-ordered walk Bo Yang
2010-07-24 15:13 ` [WIP PATCH 11/22] Add --full-line-diff option Bo Yang
2010-07-24 15:13 ` [WIP PATCH 12/22] Add tests for line history browser Bo Yang
2010-07-24 22:14   ` Thomas Rast
2010-07-24 15:13 ` Bo Yang [this message]
2010-07-24 15:13 ` [WIP PATCH 14/22] Make rewrite_parents public to other part of git Bo Yang
2010-07-24 15:13 ` [WIP PATCH 15/22] Add parent rewriting to line history browser Bo Yang
2010-07-24 15:13 ` [WIP PATCH 16/22] Add --graph prefix before line history output Bo Yang
2010-07-24 15:13 ` [WIP PATCH 17/22] Add test cases for '--graph' of line level log Bo Yang
2010-07-24 15:13 ` [WIP PATCH 18/22] a fast fix Bo Yang
2010-07-24 15:13 ` [WIP PATCH 19/22] Make graph_next_line external to other part of git Bo Yang
2010-07-24 15:13 ` [WIP PATCH 20/22] some changes Bo Yang
2010-07-24 15:13 ` [WIP PATCH 21/22] commit parents prunning code Bo Yang
2010-07-24 15:13 ` [WIP PATCH 22/22] A merge should not be printed anyway Bo Yang

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=1279984434-28933-14-git-send-email-struggleyb.nku@gmail.com \
    --to=struggleyb.nku@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).