# [PATCH 1/1] doc: small formatting fix

9 messages from 2019-09-09 to 2019-09-12. Participants: Cameron Steffen via GitGitGadget, Derrick Stolee, Johannes Schindelin, Junio C Hamano.
Thread: https://gitlist.dev/t/51820

## Cameron Steffen via GitGitGadget, 2019-09-09 23:21

Subject: [PATCH 1/1] doc: small formatting fix
Message-ID: <5248e3332c90e91c1c6a911090d331f005789014.1568071262.git.gitgitgadget@gmail.com>
URL: https://gitlist.dev/e/5248e3332c90e91c1c6a911090d331f005789014.1568071262.git.gitgitgadget%40gmail.com
In-Reply-To: <pull.330.git.gitgitgadget@gmail.com>

```
From: Cameron Steffen <cam.steffen94@gmail.com>

move an incorrectly placed backtick

Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
---
 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}`).
-- 
gitgitgadget

```

## Cameron Steffen via GitGitGadget, 2019-09-09 23:21

Subject: [PATCH 0/1] doc: small formatting fix
Message-ID: <pull.330.git.gitgitgadget@gmail.com>
URL: https://gitlist.dev/e/pull.330.git.gitgitgadget%40gmail.com

```
Edit: I need permission to submit please

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
-- 
gitgitgadget

```

## Derrick Stolee, 2019-09-11 11:49

Subject: Re: [PATCH 0/1] doc: small formatting fix
Message-ID: <2f301b94-f8da-3a36-8d3b-08593ceb1a5a@gmail.com>
URL: https://gitlist.dev/e/2f301b94-f8da-3a36-8d3b-08593ceb1a5a%40gmail.com
In-Reply-To: <pull.330.git.gitgitgadget@gmail.com>

```
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
> 

```

## Derrick Stolee, 2019-09-11 11:50

Subject: Re: [PATCH 1/1] doc: small formatting fix
Message-ID: <56b90e69-a1b2-fcaa-d300-8962565ef87b@gmail.com>
URL: https://gitlist.dev/e/56b90e69-a1b2-fcaa-d300-8962565ef87b%40gmail.com
In-Reply-To: <5248e3332c90e91c1c6a911090d331f005789014.1568071262.git.gitgitgadget@gmail.com>

```
On 9/9/2019 7:21 PM, Cameron Steffen via GitGitGadget wrote:
> From: Cameron Steffen <cam.steffen94@gmail.com>
> 
> 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 <cam.steffen94@gmail.com>
> ---
>  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}`).
> 

```

## Cameron Steffen via GitGitGadget, 2019-09-11 14:52

Subject: [PATCH v2 0/1] doc: small formatting fix
Message-ID: <pull.330.v2.git.gitgitgadget@gmail.com>
URL: https://gitlist.dev/e/pull.330.v2.git.gitgitgadget%40gmail.com
In-Reply-To: <pull.330.git.gitgitgadget@gmail.com>

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

Cameron Steffen (1):
  doc: minor 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-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-330/camsteffen/patch-1-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/330

Range-diff vs v1:

 1:  5248e3332c ! 1:  8e64007452 doc: small formatting fix
     @@ -1,8 +1,8 @@
      Author: Cameron Steffen <cam.steffen94@gmail.com>
      
     -    doc: small formatting fix
     +    doc: minor formatting fix
      
     -    move an incorrectly placed backtick
     +    Move a closing backtick that was placed one character too soon.
      
          Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
      

-- 
gitgitgadget

```

## Cameron Steffen via GitGitGadget, 2019-09-11 14:52

Subject: [PATCH v2 1/1] doc: minor formatting fix
Message-ID: <8e6400745275e0af317552e73384101e5745a667.1568213570.git.gitgitgadget@gmail.com>
URL: https://gitlist.dev/e/8e6400745275e0af317552e73384101e5745a667.1568213570.git.gitgitgadget%40gmail.com
In-Reply-To: <pull.330.v2.git.gitgitgadget@gmail.com>

```
From: Cameron Steffen <cam.steffen94@gmail.com>

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

Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
---
 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}`).
-- 
gitgitgadget

```

## Johannes Schindelin, 2019-09-11 21:21

Subject: Re: [PATCH 0/1] doc: small formatting fix
Message-ID: <nycvar.QRO.7.76.6.1909112321270.5377@tvgsbejvaqbjf.bet>
URL: https://gitlist.dev/e/nycvar.QRO.7.76.6.1909112321270.5377%40tvgsbejvaqbjf.bet
In-Reply-To: <pull.330.git.gitgitgadget@gmail.com>

```
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%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
> --
> gitgitgadget
>

```

## Johannes Schindelin, 2019-09-11 21:24

Subject: Re: [PATCH 1/1] doc: small formatting fix
Message-ID: <nycvar.QRO.7.76.6.1909112322220.5377@tvgsbejvaqbjf.bet>
URL: https://gitlist.dev/e/nycvar.QRO.7.76.6.1909112322220.5377%40tvgsbejvaqbjf.bet
In-Reply-To: <5248e3332c90e91c1c6a911090d331f005789014.1568071262.git.gitgitgadget@gmail.com>

```
Hi Cameron,

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

> From: Cameron Steffen <cam.steffen94@gmail.com>
>
> move an incorrectly placed backtick

This sentence is incomplete, and does not really explain _why_ the
backtick needs to be moved. Something like this would be much clearer:

	Most likely by mistake, the closing curly brace was added
	_after_ the backtick instead of _before_ it. This breaks the
	formatting. Let's fix that.

The patch looks good, though.

To send another iteration of this patch, amend your commit locally,
force-push, and issue another `/submit`.

Ciao,
Johannes

>
> Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
> ---
>  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}`).
> --
> gitgitgadget
>

```

## Junio C Hamano, 2019-09-12 18:06

Subject: Re: [PATCH v2 1/1] doc: minor formatting fix
Message-ID: <xmqq4l1hgzjc.fsf@gitster-ct.c.googlers.com>
URL: https://gitlist.dev/e/xmqq4l1hgzjc.fsf%40gitster-ct.c.googlers.com
In-Reply-To: <8e6400745275e0af317552e73384101e5745a667.1568213570.git.gitgitgadget@gmail.com>

```
"Cameron Steffen via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Cameron Steffen <cam.steffen94@gmail.com>
>
> Move a closing backtick that was placed one character too soon.
>
> Signed-off-by: Cameron Steffen <cam.steffen94@gmail.com>
> ---
>  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}`).

```
