From: martin f. krafft <hidden> Date: 2016-06-15 22:45:25
The need for "--" in the git-log synopsis was previously unclear and
confusing. This patch makes it a little clearer.
Thanks to hyy [off-list ref] for his help.
Signed-off-by: martin f. krafft <redacted>
---
Documentation/git-log.txt | 8 +++++---
1 files changed, 5 insertions(+), 3 deletions(-)
@@ -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[]
@@ -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.
From: martin f. krafft <hidden> Date: 2016-06-15 22:45:25
The need for "--" in the git-log synopsis was previously unclear and
confusing. This patch makes it a little clearer.
Thanks to hyy [off-list ref] for his help.
Signed-off-by: martin f. krafft <redacted>
---
Documentation/git-log.txt | 8 +++++---
1 files changed, 5 insertions(+), 3 deletions(-)
@@ -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[]