Re: [PATCH v3 13/13] some document update

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Jakub,

On Sun, Jul 11, 2010 at 4:27 PM, Jakub Narebski <jnareb@xxxxxxxxx> wrote:
>
> If the parsing code for -L <start>,<end> is the same for git-blame and
> for git-log, and therefore documentation is the same or nearly the
> same for this option, wouldn't it be better to separate this
> documentation into separate file, e.g. line-range-option.txt, and
> include it both in git-blame and git-log manpages?  If there are minor
> differences, they can be covered by ifdefs.
>

Thanks a lot for your advice, I have revised the patch.

-----------------------------------------------------------
>From 88ed88a53d83c2d46fa4917008efadc531ba1068 Mon Sep 17 00:00:00 2001
From: Bo Yang <struggleyb.nku@xxxxxxxxx>
Date: Sat, 26 Jun 2010 01:35:48 -0700
Subject: [PATCH v3 revised 13/13] some document update

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

Signed-off-by: Bo Yang <struggleyb.nku@xxxxxxxxx>
---
 Documentation/blame-options.txt     |   19 +------------------
 Documentation/git-log.txt           |   13 +++++++++++++
 Documentation/line-range-format.txt |   18 ++++++++++++++++++
 3 files changed, 32 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 0e6ff31..4781f8b 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
 -------
@@ -72,6 +76,15 @@ include::diff-options.txt[]
 	to be prefixed with "\-- " to separate them from options or
 	refnames.

+-L <start>,<end>::
+	The line range.  <start> and <end> can take one of these forms:
+
+include::line-range-format.txt[]
+
+--always-print::
+	Always print the interesting range even if the current commit
+	does not change any line of the range.
+

 include::rev-list-options.txt[]

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
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]