Skip to content

doc: small formatting fix #330

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

Closed
wants to merge 1 commit into from
Closed

Conversation

camsteffen
Copy link

@camsteffen camsteffen commented Sep 3, 2019

Move a closing backtick that was placed one character too soon.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 3, 2019

Welcome to GitGitGadget

Hi @camsteffen, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that this Pull Request has a good description, as it will be used as cover letter.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

  • the lines should not exceed 76 columns,
  • the first line should be like a header and typically start with a prefix like "tests:" or "commit:", and
  • the commit messages' body should be describing the "why?" of the change.
  • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a PR comment of the form /allow <username>.

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions.

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox ("raw") file corresponding to the mail you want to reply to from the Git mailing list. If you use GMail, you can upload that raw mbox file via:

curl -g --user "<EMailAddress>:<Password>" --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

@camsteffen
Copy link
Author

@derrickstolee can I pick on you to give me permission to submit?

@camsteffen
Copy link
Author

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 5, 2019

Error: User camsteffen is not permitted to use GitGitGadget

@dscho
Copy link
Member

dscho commented Sep 9, 2019

/allow camsteffen

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 9, 2019

User camsteffen is now allowed to use GitGitGadget.

@camsteffen
Copy link
Author

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 9, 2019

Submitted as [email protected]

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 11, 2019

On the Git mailing list, Derrick Stolee wrote (reply to this):

On 9/9/2019 7:21 PM, Cameron Steffen via GitGitGadget wrote:
> Edit: I need permission to submit please

Hi Cameron.

When using GitGitGadget, your PR description becomes your cover letter on the mailing list. This is a great place for you to describe how you discovered this problem and if you have looked elsewhere for similar issues to fix up.

Thanks,
-Stolee
> 
> Cameron Steffen (1):
>   doc: small formatting fix
> 
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> 
> base-commit: 75b2f01a0f642b39b0f29b6218515df9b5eb798e
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-330%2Fcamsteffen%2Fpatch-1-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-330/camsteffen/patch-1-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/330
> 

@@ -208,7 +208,7 @@ endif::git-rev-list[]
'%GP':: show the fingerprint of the primary key whose subkey was used
Copy link

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, Derrick Stolee wrote (reply to this):

On 9/9/2019 7:21 PM, Cameron Steffen via GitGitGadget wrote:
> From: Cameron Steffen <[email protected]>
> 
> move an incorrectly placed backtick

The change below is simple enough, but we prefer using full sentences in the commit messages. This includes capitalization and punctuation.

Thanks,
-Stolee
 
> Signed-off-by: Cameron Steffen <[email protected]>
> ---
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index 079598307a..b87e2e83e6 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -208,7 +208,7 @@ endif::git-rev-list[]
>  '%GP':: show the fingerprint of the primary key whose subkey was used
>  	to sign a signed commit
>  '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
> -	minutes ago`}; the format follows the rules described for the
> +	minutes ago}`; the format follows the rules described for the
>  	`-g` option. The portion before the `@` is the refname as
>  	given on the command line (so `git log -g refs/heads/master`
>  	would yield `refs/heads/master@{0}`).
> 

Move a closing backtick that was placed one character too soon.

Signed-off-by: Cameron Steffen <[email protected]>
@camsteffen
Copy link
Author

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 11, 2019

Error: Ignoring PR with empty title and/or body

@camsteffen
Copy link
Author

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 11, 2019

Submitted as [email protected]

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 11, 2019

On the Git mailing list, Johannes Schindelin wrote (reply to this):

Hi Cameron,

On Mon, 9 Sep 2019, Cameron Steffen via GitGitGadget wrote:

> Edit: I need permission to submit please

You got that permission already ;-)

Ciao,
Johannes

>
> Cameron Steffen (1):
>   doc: small formatting fix
>
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
>
> base-commit: 75b2f01a0f642b39b0f29b6218515df9b5eb798e
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-330%2F=
camsteffen%2Fpatch-1-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-330/camst=
effen/patch-1-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/330
> --
> gitgitgadget
>

@@ -208,7 +208,7 @@ endif::git-rev-list[]
'%GP':: show the fingerprint of the primary key whose subkey was used
Copy link

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):

"Cameron Steffen via GitGitGadget" <[email protected]> writes:

> From: Cameron Steffen <[email protected]>
>
> Move a closing backtick that was placed one character too soon.
>
> Signed-off-by: Cameron Steffen <[email protected]>
> ---
>  Documentation/pretty-formats.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Thanks for spotting and fixing.  Will apply.

>
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index 079598307a..b87e2e83e6 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -208,7 +208,7 @@ endif::git-rev-list[]
>  '%GP':: show the fingerprint of the primary key whose subkey was used
>  	to sign a signed commit
>  '%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2
> -	minutes ago`}; the format follows the rules described for the
> +	minutes ago}`; the format follows the rules described for the
>  	`-g` option. The portion before the `@` is the refname as
>  	given on the command line (so `git log -g refs/heads/master`
>  	would yield `refs/heads/master@{0}`).

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 12, 2019

This branch is now known as cs/pretty-formats-doc-typofix.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 12, 2019

This patch series was integrated into pu via git@d7f9ce0.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 16, 2019

This patch series was integrated into pu via git@7259d91.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 17, 2019

This patch series was integrated into pu via git@93592da.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 18, 2019

This patch series was integrated into pu via git@a53b884.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 18, 2019

This patch series was integrated into pu via git@4470493.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 20, 2019

This patch series was integrated into pu via git@dc70ce7.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 30, 2019

This patch series was integrated into pu via git@24df5cd.

@gitgitgadget
Copy link

gitgitgadget bot commented Sep 30, 2019

This patch series was integrated into next via git@a29a425.

@gitgitgadget gitgitgadget bot added the next label Sep 30, 2019
@gitgitgadget
Copy link

gitgitgadget bot commented Oct 2, 2019

This patch series was integrated into pu via git@0c05222.

@gitgitgadget
Copy link

gitgitgadget bot commented Oct 3, 2019

This patch series was integrated into pu via git@877d754.

@gitgitgadget
Copy link

gitgitgadget bot commented Oct 4, 2019

This patch series was integrated into pu via git@d1d1bd3.

@gitgitgadget
Copy link

gitgitgadget bot commented Oct 6, 2019

This patch series was integrated into pu via git@f2052f1.

@gitgitgadget
Copy link

gitgitgadget bot commented Oct 7, 2019

This patch series was integrated into pu via git@cb3ec6f.

@gitgitgadget
Copy link

gitgitgadget bot commented Oct 7, 2019

This patch series was integrated into next via git@cb3ec6f.

@gitgitgadget
Copy link

gitgitgadget bot commented Oct 7, 2019

This patch series was integrated into master via git@cb3ec6f.

@gitgitgadget gitgitgadget bot added the master label Oct 7, 2019
@gitgitgadget gitgitgadget bot closed this Oct 7, 2019
@gitgitgadget
Copy link

gitgitgadget bot commented Oct 7, 2019

Closed via cb3ec6f.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants