Skip to contentSkip to conversation

doc: small formatting fix

PATCH Superseded Cameron Steffen via GitGitGadget 4 participants 9 messages Sep 9, 2019 – Sep 12, 2019 Documentation

lore
Share & tools
lore
#1 lore raw

PATCH 1/1 doc: small formatting fix

In reply to Cameron Steffen via GitGitGadget

From: Cameron Steffen <[email protected]>

move an incorrectly placed backtick

---
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/pretty-formats.txt +1 -1
index 079598307a..b87e2e83e6 100644
@@ -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}`).
Signature · 1 line
gitgitgadget
#0 lore raw

cover doc: small formatting fix

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

Signature · 1 line
gitgitgadget
#4 lore raw
Quoted 1 line · Cameron Steffen via GitGitGadget

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

Quoted 13 lines

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

#2 lore raw
In reply to Cameron Steffen via GitGitGadget
Quoted 3 lines · Cameron Steffen via GitGitGadget

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

Quoted 19 lines
---
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/pretty-formats.txt +1 -1
index 079598307a..b87e2e83e6 100644
@@ -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}`).
#5 lore raw

v2 cover doc: small formatting fix

In reply to Cameron Steffen via GitGitGadget

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 <[email protected]>

- doc: small formatting fix
+ doc: minor formatting fix

- move an incorrectly placed backtick
+ Move a closing backtick that was placed one character too soon.

Signature · 1 line
gitgitgadget
#6 lore raw

PATCH v2 1/1 doc: minor formatting fix

From: Cameron Steffen <[email protected]>

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

---
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/pretty-formats.txt +1 -1
index 079598307a..b87e2e83e6 100644
@@ -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}`).
Signature · 1 line
gitgitgadget
#8 lore raw
In reply to Cameron Steffen via GitGitGadget

Hi Cameron,

Quoted 1 line · Cameron Steffen via GitGitGadget

Edit: I need permission to submit please

You got that permission already ;-)

Ciao,
Johannes

Quoted 15 lines

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

#3 lore raw
In reply to Cameron Steffen via GitGitGadget

Hi Cameron,

Quoted 3 lines · Cameron Steffen via GitGitGadget

From: Cameron Steffen <[email protected]>

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

Quoted 22 lines
---
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/pretty-formats.txt +1 -2
index 079598307a..b87e2e83e6 100644
@@ -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

#7 lore raw

Re: [PATCH v2 1/1] doc: minor formatting fix

In reply to Cameron Steffen via GitGitGadget
Quoted 8 lines · Cameron Steffen via GitGitGadget

From: Cameron Steffen <[email protected]>

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

---
 Documentation/pretty-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thanks for spotting and fixing. Will apply.

Quoted 14 lines
Documentation/pretty-formats.txt +1 -1
index 079598307a..b87e2e83e6 100644
@@ -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}`).