-
Notifications
You must be signed in to change notification settings - Fork 143
doc: include git rev-list
description in git log
doc
#590
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: include git rev-list
description in git log
doc
#590
Conversation
/submit |
Submitted as pull.590.git.1585429894378.gitgitgadget@gmail.com |
On the Git mailing list, Junio C Hamano wrote (reply to this):
|
On the Git mailing list, Philippe Blain wrote (reply to this):
|
On the Git mailing list, Junio C Hamano wrote (reply to this):
|
On the Git mailing list, Taylor Blau wrote (reply to this):
|
2e9afad
to
cdf282f
Compare
git rev-list
description and include it in git log
doc
git rev-list
description and include it in git log
docgit rev-list
description in git log
doc
cdf282f
to
3b92378
Compare
/submit |
Submitted as pull.590.v2.git.1593747509.gitgitgadget@gmail.com |
On the Git mailing list, Philip Oakley wrote (reply to this):
|
@@ -15,9 +15,9 @@ DESCRIPTION | |||
----------- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the Git mailing list, Junio C Hamano wrote (reply to this):
"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: Philippe Blain <levraiphilippeblain@gmail.com>
>
> Add links to the documentation for `git rev-list` and `git diff`
> instead of simply mentioning them, to make it easier for readers to reach
> these documentation pages. Let's link to `git diff` as this is the
> porcelain command, and the rest of the family (`diff-index`, `diff-tree` and
> `diff-files`) are mentioned in the "Raw output format" section of the
> `git diff` documentation.
>
> Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
> ---
> Documentation/git-log.txt | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 20e6d21a74..04ea18d1c0 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -15,9 +15,9 @@ DESCRIPTION
> -----------
> Shows the commit logs.
>
> -The command takes options applicable to the `git rev-list`
> +The command takes options applicable to the linkgit:git-rev-list[1]
> command to control what is shown and how, and options applicable to
> -the `git diff-*` commands to control how the changes
> +the linkgit:git-diff[1] family of commands to control how the changes
> each commit introduces are shown.
The original did mean "git diff-*" family of plumbing commands, but
I think it makes more sense these days to just refer to "git diff"
Porcelain, which is the single entry point everybody uses. So you
would probably want to further replace "family of commands" with
just "command" in the text.
Other than that, I think making these into links is a good idea.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the Git mailing list, Philippe Blain wrote (reply to this):
Hi Junio,
> Le 6 juil. 2020 à 20:55, Junio C Hamano <gitster@pobox.com> a écrit :
>
> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> From: Philippe Blain <levraiphilippeblain@gmail.com>
>>
---8<---
>>
>> -The command takes options applicable to the `git rev-list`
>> +The command takes options applicable to the linkgit:git-rev-list[1]
>> command to control what is shown and how, and options applicable to
>> -the `git diff-*` commands to control how the changes
>> +the linkgit:git-diff[1] family of commands to control how the changes
>> each commit introduces are shown.
>
> The original did mean "git diff-*" family of plumbing commands, but
> I think it makes more sense these days to just refer to "git diff"
> Porcelain, which is the single entry point everybody uses. So you
> would probably want to further replace "family of commands" with
> just "command" in the text.
>
Right. I'll change that.
> Other than that, I think making these into links is a good idea.
Thanks,
Philippe.
P.S. sorry for the resend, I forgot to convert the message to plain text the first time...
@@ -0,0 +1,61 @@ | |||
List commits that are reachable by following the `parent` links from the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the Git mailing list, Junio C Hamano wrote (reply to this):
"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: Philippe Blain <levraiphilippeblain@gmail.com>
>
> Using '{caret}' inside double quotes and immediately following with a
> single quoted word does not create the desired output: '<commit1>'
> appears verbatim instead of being emphasized.
>
> Use a litteral caret ('^') instead.
>
> Also, remove the leading tabs in shell examples to bring them more in
> line with the rest of the documentation.
These should be done _before_ 2/4 as a preliminary clean-up, I
think.
Thanks for a pleasant read.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the Git mailing list, Philippe Blain wrote (reply to this):
> Le 6 juil. 2020 à 20:59, Junio C Hamano <gitster@pobox.com> a écrit :
>
> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> From: Philippe Blain <levraiphilippeblain@gmail.com>
>>
>> Using '{caret}' inside double quotes and immediately following with a
>> single quoted word does not create the desired output: '<commit1>'
>> appears verbatim instead of being emphasized.
>>
>> Use a litteral caret ('^') instead.
>>
>> Also, remove the leading tabs in shell examples to bring them more in
>> line with the rest of the documentation.
>
> These should be done _before_ 2/4 as a preliminary clean-up, I
> think.
I agree. I'll reorder that for v3.
This branch is now known as |
This patch series was integrated into seen via git@6ca1fdc. |
This patch series was integrated into seen via git@d9855b4. |
On the Git mailing list, Philippe Blain wrote (reply to this):
|
This patch series was integrated into seen via git@e824c73. |
Add links to the documentation for `git rev-list` and `git diff` instead of simply mentioning them, to make it easier for readers to reach these documentation pages. Let's link to `git diff` as this is the porcelain command, and the rest of the family (`diff-index`, `diff-tree` and `diff-files`) are mentioned in the "Raw output format" section of the `git diff` documentation. Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
3b92378
to
f035949
Compare
This patch series was integrated into seen via git@e34a351. |
f035949
to
0aa9026
Compare
The "Specifying ranges" section does not mention explicitly that several commits can be specified to form a range. Add a mention to that effect. Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Using '{caret}' inside double quotes and immediately following with a single quoted word does not create the desired output: '<commit1>' appears verbatim instead of being emphasized. Use a litteral caret ('^') instead. Also, remove the leading tabs in shell examples to bring them more in line with the rest of the documentation. Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Tweak a sentence to make it a little more readable. Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
@dscho when I get CI failures like this, that are not caused by my commits (this series only changes files under |
I didn't find a way to subscribe to all workflow failures... So yes, I appreciate a ping. The build is now running again. |
This patch series was integrated into seen via git@2e682d4. |
This patch series was integrated into seen via git@a6ca601. |
This patch series was integrated into seen via git@78c9c63. |
This patch series was integrated into seen via git@abf8c2d. |
This patch series was integrated into seen via git@e4f3761. |
This patch series was integrated into seen via git@3984bfa. |
This patch series was integrated into seen via git@db5f7e8. |
This patch series was integrated into seen via git@cb96896. |
This patch series was integrated into seen via git@59c3925. |
This patch series was integrated into seen via git@e9101b7. |
This patch series was integrated into seen via git@9377aae. |
This patch series was integrated into seen via git@a29735c. |
This patch series was integrated into seen via git@27d8d09. |
This patch series was integrated into seen via git@773afbc. |
This patch series was integrated into seen via git@9107889. |
This patch series was integrated into seen via git@b79c1d0. |
This patch series was integrated into seen via git@8af2155. |
This patch series was integrated into seen via git@e7fd9f0. |
This patch series was integrated into seen via git@5ca82e3. |
This patch series was integrated into next via git@5ca82e3. |
This patch series was integrated into master via git@5ca82e3. |
Closed via 5ca82e3. |
Changes since v2:
git rev-list
descriptionrevisions.txt
to mention explicitly what it means to list several revisions to form a range.v2:
This series moves the nice explanation in the 'Description' section
of the
git rev-list
man page to a separate file and includes this filein the
git log
man page.This goal is to make readers more aware that they can write e.g.
to see commits on each of branch1-4, that are not on master,
since this is not immediately obvious (at least to me)
in the
git log
man page.Note that I made several commits for ease of reviewing,
I'll squash some if this would be preferred.
Changes since v1: took a completely different approach
following the comments received from Junio and Taylor.
CC: Lawrence Siebert lawrencesiebert@gmail.com, Denton Liu liu.denton@gmail.com, Junio C Hamano gitster@pobox.com, Taylor Blau me@ttaylorr.com, Philip Oakley philipoakley@iee.email