[PATCH] Include rev-list options in git-log manpage.

Previous thread: git-svn: how to connect SVN branches? by dherring on Thursday, January 17, 2008 - 4:17 pm. (4 messages)

Next thread: [PATCH] gitk: Add checkbutton to ignore space changes by Steffen Prohaska on Thursday, January 17, 2008 - 6:42 pm. (1 message)
To: Junio C Hamano <gitster@...>
Cc: <git@...>
Date: Thursday, January 17, 2008 - 5:44 pm

It seems that all the git-rev-list options (--grep, --author, etc) were missing
from the git-log manpage. This can be quite problematic if one does not know
that git-log accepts the options of git-rev-list.

So move these options to a separate file and include it from both
git-rev-list.txt and git-log.txt.

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---

Noticed by tsuna on IRC. I hope this is okay for 1.5.4.

Documentation/git-log.txt | 2 +
Documentation/git-rev-list.txt | 358 +-----------------------------------
Documentation/rev-list-options.txt | 356 +++++++++++++++++++++++++++++++++++
3 files changed, 359 insertions(+), 357 deletions(-)
create mode 100644 Documentation/rev-list-options.txt

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 5985f47..8095707 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -80,6 +80,8 @@ include::diff-options.txt[]
Show only commits that affect the specified paths.

+include::rev-list-options.txt[]
+
include::pretty-formats.txt[]

include::diff-generate-patch.txt[]
diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index db42cd8..6a4b0cf 100644
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -88,363 +88,7 @@ linkgit:git-repack[1].
OPTIONS
-------

-Commit Formatting
-~~~~~~~~~~~~~~~~~
-
-Using these options, linkgit:git-rev-list[1] will act similar to the
-more specialized family of commit log tools: linkgit:git-log[1],
-linkgit:git-show[1], and linkgit:git-whatchanged[1]
-
-include::pretty-options.txt[]
-
---relative-date::
-
- Synonym for `--date=relative`.
-
---date={relative,local,default,iso,rfc}::
-
- Only takes effect for dates shown in human-readable format, such
- as when using "--pretty".
-+
-`--date=relative` shows dates relative to the current time,
-e.g. "2 hours ago".
-+
-`--date=local` shows timestamps in user's local timezone.
-+
-`--date=iso` (or `-...

To: Miklos Vajna <vmiklos@...>
Cc: <git@...>
Date: Friday, January 18, 2008 - 3:21 am

Have you generated documentation with and without patch and run
diff between them?

There is an obvious duplicated inclusion of pretty-options.txt[]
in git-log.{1,html}.

is _clearly_ written for git-rev-list and unsuitable for any of
the commands listed above.

git-log manual page has been saying that "This manual page
describes only the most frequently used options." I would agree
that it is a laudable goal to replace that sentence with an
included common source text, but there needs to be a bit more
careful copyediting than your a patch.

-

To: Junio C Hamano <gitster@...>
Cc: <git@...>
Date: Friday, January 18, 2008 - 12:17 pm

Replace the "This manual page describes only the most frequently used options."
text with the list of rev-list options in git-log manpage. (The git-diff-tree
options are already included.)

Move these options to a separate file and include it from both
git-rev-list.txt and git-log.txt.

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---

Yes and no. I generated the documentation, but I forgot to diff the

I missed that one. Now should be fixed. Also there were other duplicated

Fixed. Also the other occurences, like --objects, where the text was

As the git-diff-tree options were already included, and this patch
adds the git-rev-list options, I removed this text.

Documentation/git-log.txt | 6 +-
Documentation/git-rev-list.txt | 358 +-----------------------------------
Documentation/rev-list-options.txt | 364 ++++++++++++++++++++++++++++++++++++
3 files changed, 367 insertions(+), 361 deletions(-)
create mode 100644 Documentation/rev-list-options.txt

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 5985f47..e981618 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -19,14 +19,10 @@ command to control what is shown and how, and options applicable to
the linkgit:git-diff-tree[1] commands to control how the changes
each commit introduces are shown.

-This manual page describes only the most frequently used options.
-

OPTIONS
-------

-include::pretty-options.txt[]
-
:git-log: 1
include::diff-options.txt[]

@@ -80,6 +76,8 @@ include::diff-options.txt[]
Show only commits that affect the specified paths.

+include::rev-list-options.txt[]
+
include::pretty-formats.txt[]

include::diff-generate-patch.txt[]
diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index db42cd8..6a4b0cf 100644
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -88,363 +88,7 @@ linkgit:git-repack[1].
OPTIONS
-------

-Commit Forma...

To: Miklos Vajna <vmiklos@...>
Cc: Junio C Hamano <gitster@...>, <git@...>
Date: Friday, January 18, 2008 - 12:37 pm

Had you used format-patch -C then the patch would have been shorter by
~240 lines. And it would have been immediately obvious that you have put

I wonder why these brackets are necessary. This text applies to git-log,
too, no? Can't you just remove that paragraph from git-log.txt?

-- Hannes
-

To: Junio C Hamano <gitster@...>
Cc: <git@...>, Johannes Sixt <j.sixt@...>
Date: Friday, January 18, 2008 - 1:18 pm

Replace the "This manual page describes only the most frequently used options."
text with the list of rev-list options in git-log manpage. (The git-diff-tree
options are already included.)

Move these options to a separate file and include it from both
git-rev-list.txt and git-log.txt.

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---

Okay, now using -C :)

Also I removed the duplicated options from git-log.txt (--first-parent
and -g) to avoid duplicated descriptions.

Documentation/git-log.txt | 21 +-
Documentation/git-rev-list.txt | 358 +-------------------
.../{git-rev-list.txt => rev-list-options.txt} | 118 +------
3 files changed, 11 insertions(+), 486 deletions(-)
copy Documentation/{git-rev-list.txt => rev-list-options.txt} (76%)

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 5985f47..ebaee4b 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -19,14 +19,10 @@ command to control what is shown and how, and options applicable to
the linkgit:git-diff-tree[1] commands to control how the changes
each commit introduces are shown.

-This manual page describes only the most frequently used options.
-

OPTIONS
-------

-include::pretty-options.txt[]
-
:git-log: 1
include::diff-options.txt[]

@@ -41,21 +37,6 @@ include::diff-options.txt[]
and <until>, see "SPECIFYING REVISIONS" section in
linkgit:git-rev-parse[1].

---first-parent::
- Follow only the first parent commit upon seeing a merge
- commit. This option can give a better overview when
- viewing the evolution of a particular topic branch,
- because merges into a topic branch tend to be only about
- adjusting to updated upstream from time to time, and
- this option allows you to ignore the individual commits
- brought in to your history by such a merge.
-
--g, \--walk-reflogs::
- Show commits as they were recorded in the reflog. The log contains
- a record ...

To: Miklos Vajna <vmiklos@...>
Cc: <git@...>, Johannes Sixt <j.sixt@...>
Date: Friday, January 18, 2008 - 3:51 pm

I do not like these. What you are really trying to express is
"this section makes sense only in rev-list documentation", not
"among the current set of documentation, the one this section
does not make sense in is git-log". We might end up including
this in some other documents.

IOW, they should rather be "ifdef::git-rev-list[]" instead,
(of course you have to define that token yourself if there isn't
one already).

-

To: Junio C Hamano <gitster@...>
Cc: <git@...>, Johannes Sixt <j.sixt@...>
Date: Friday, January 18, 2008 - 6:50 pm

[Empty message]
To: Junio C Hamano <gitster@...>
Cc: <git@...>, Johannes Sixt <j.sixt@...>
Date: Friday, January 18, 2008 - 6:58 pm

Replace the "This manual page describes only the most frequently used options."
text with the list of rev-list options in git-log manpage. (The git-diff-tree
options are already included.)

Move these options to a separate file and include it from both
git-rev-list.txt and git-log.txt.

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---

My bad, the previous version introduced two typos (ref-list instead of
rev-list). This one should be OK.

Documentation/git-log.txt | 21 +-
Documentation/git-rev-list.txt | 359 +-------------------
.../{git-rev-list.txt => rev-list-options.txt} | 118 +------
3 files changed, 12 insertions(+), 486 deletions(-)
copy Documentation/{git-rev-list.txt => rev-list-options.txt} (76%)

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 5985f47..ebaee4b 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -19,14 +19,10 @@ command to control what is shown and how, and options applicable to
the linkgit:git-diff-tree[1] commands to control how the changes
each commit introduces are shown.

-This manual page describes only the most frequently used options.
-

OPTIONS
-------

-include::pretty-options.txt[]
-
:git-log: 1
include::diff-options.txt[]

@@ -41,21 +37,6 @@ include::diff-options.txt[]
and <until>, see "SPECIFYING REVISIONS" section in
linkgit:git-rev-parse[1].

---first-parent::
- Follow only the first parent commit upon seeing a merge
- commit. This option can give a better overview when
- viewing the evolution of a particular topic branch,
- because merges into a topic branch tend to be only about
- adjusting to updated upstream from time to time, and
- this option allows you to ignore the individual commits
- brought in to your history by such a merge.
-
--g, \--walk-reflogs::
- Show commits as they were recorded in the reflog. The log contains
- a record about how the tip of a reference ...

To: Miklos Vajna <vmiklos@...>
Cc: <git@...>, Johannes Sixt <j.sixt@...>
Date: Friday, January 18, 2008 - 7:12 pm

Now, this moves option descriptions of git-log around for no
good reason, other than that it was more convenient in the
source.

Which is not a very good excuse in general, but I do not think
the original ordering was carefully designed to be optimal for
the readers either, so let's take it.

Thanks.
-

To: Miklos Vajna <vmiklos@...>
Cc: <git@...>, Johannes Sixt <j.sixt@...>
Date: Friday, January 18, 2008 - 3:50 pm

I do not like these. What you are really trying to express is
"this section makes sense only in rev-list documentation", not
"the current set of documentation this section does not make
sese is git-log". We might end up including this in some other
documents.

IOW, they should rather be "ifdef::git-rev-list[]" instead.
-

Previous thread: git-svn: how to connect SVN branches? by dherring on Thursday, January 17, 2008 - 4:17 pm. (4 messages)

Next thread: [PATCH] gitk: Add checkbutton to ignore space changes by Steffen Prohaska on Thursday, January 17, 2008 - 6:42 pm. (1 message)