* [PATCH] Improve git-log documentation wrt file filters
@ 2008-09-30 14:36 martin f. krafft
2008-09-30 19:25 ` Shawn O. Pearce
0 siblings, 1 reply; 3+ messages in thread
From: martin f. krafft @ 2008-09-30 14:36 UTC (permalink / raw)
To: git; +Cc: martin f. krafft
The need for "--" in the git-log synopsis was previously unclear and
confusing. This patch makes it a little clearer.
Thanks to hyy <yiyihu@gmail.com> for his help.
Signed-off-by: martin f. krafft <madduck@madduck.net>
---
Documentation/git-log.txt | 8 +++++---
1 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 0446bad..b7409f8 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -8,7 +8,7 @@ git-log - Show commit logs
SYNOPSIS
--------
-'git log' <option>...
+'git log' [<options>] [<since>..<until>] [[--] <path>...]
DESCRIPTION
-----------
@@ -57,8 +57,10 @@ include::diff-options.txt[]
Note that only message is considered, if also a diff is shown
its size is not included.
-<path>...::
- Show only commits that affect any of the specified paths.
+-- <path>...::
+ Show only commits that affect any of the specified paths. To
+ prevent confusion with options and branch names, paths should be
+ prefixed with "-- " to separate them from options or refnames.
include::rev-list-options.txt[]
--
1.5.6.5
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] Improve git-log documentation wrt file filters
2008-09-30 14:36 [PATCH] Improve git-log documentation wrt file filters martin f. krafft
@ 2008-09-30 19:25 ` Shawn O. Pearce
2008-09-30 19:57 ` martin f. krafft
0 siblings, 1 reply; 3+ messages in thread
From: Shawn O. Pearce @ 2008-09-30 19:25 UTC (permalink / raw)
To: martin f. krafft; +Cc: git
"martin f. krafft" <madduck@madduck.net> wrote:
> The need for "--" in the git-log synopsis was previously unclear and
> confusing. This patch makes it a little clearer.
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 0446bad..b7409f8 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -8,7 +8,7 @@ git-log - Show commit logs
>
> SYNOPSIS
> --------
> -'git log' <option>...
> +'git log' [<options>] [<since>..<until>] [[--] <path>...]
This part is really useful.
> DESCRIPTION
> -----------
> @@ -57,8 +57,10 @@ include::diff-options.txt[]
> Note that only message is considered, if also a diff is shown
> its size is not included.
>
> -<path>...::
> - Show only commits that affect any of the specified paths.
> +-- <path>...::
> + Show only commits that affect any of the specified paths. To
> + prevent confusion with options and branch names, paths should be
> + prefixed with "-- " to separate them from options or refnames.
Indentation here looks wrong, especially on the last two lines.
I'm also not sure we want to say "-- <path>" in the header for
this section. The -- is optional but I'm reading this as though it
is required. Maybe "... paths can be prefixed with -- ..." instead?
--
Shawn.
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH] Improve git-log documentation wrt file filters
2008-09-30 19:25 ` Shawn O. Pearce
@ 2008-09-30 19:57 ` martin f. krafft
0 siblings, 0 replies; 3+ messages in thread
From: martin f. krafft @ 2008-09-30 19:57 UTC (permalink / raw)
To: git; +Cc: martin f. krafft
The need for "--" in the git-log synopsis was previously unclear and
confusing. This patch makes it a little clearer.
Thanks to hyy <yiyihu@gmail.com> for his help.
Signed-off-by: martin f. krafft <madduck@madduck.net>
---
Documentation/git-log.txt | 8 +++++---
1 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 0446bad..5a3a625 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -8,7 +8,7 @@ git-log - Show commit logs
SYNOPSIS
--------
-'git log' <option>...
+'git log' [<options>] [<since>..<until>] [[--] <path>...]
DESCRIPTION
-----------
@@ -57,8 +57,10 @@ include::diff-options.txt[]
Note that only message is considered, if also a diff is shown
its size is not included.
-<path>...::
- Show only commits that affect any of the specified paths.
+[--] <path>...::
+ Show only commits that affect any of the specified paths. To
+ prevent confusion with options and branch names, paths may need to be
+ prefixed with "-- " to separate them from options or refnames.
include::rev-list-options.txt[]
--
1.5.6.5
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2008-09-30 19:59 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-09-30 14:36 [PATCH] Improve git-log documentation wrt file filters martin f. krafft
2008-09-30 19:25 ` Shawn O. Pearce
2008-09-30 19:57 ` martin f. krafft
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).