diff mbox series

[v2,5/5] doc: migrate git-commit manpage secondary files to new format

Message ID 28316a709da913c624873291d96ed5aeddc6fc90.1736972628.git.gitgitgadget@gmail.com (mailing list archive)
State New
Headers show
Series Doc git commit | expand

Commit Message

Jean-Noël Avila Jan. 15, 2025, 8:23 p.m. UTC 
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
 Documentation/i18n.txt           | 4 ++--
 Documentation/signoff-option.txt | 8 ++++----
 2 files changed, 6 insertions(+), 6 deletions(-)

Comments

Patrick Steinhardt Jan. 16, 2025, 10:17 a.m. UTC | #1 
On Wed, Jan 15, 2025 at 08:23:48PM +0000, Jean-Noël Avila via GitGitGadget wrote:
> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

I would've liked to see a small description of what this does and also
provide a bit more context in the other commit messages instead of the
bulleted lists you have. They don't give the reader much of a sense of
the context we're operating in and why we think that those changes are
good.

Other than that the patch series looks fine to me. Thanks!

Patrick
diff mbox series

Patch

diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt
index 3a866af4a42..baff780a7e3 100644
--- a/Documentation/i18n.txt
+++ b/Documentation/i18n.txt
@@ -34,7 +34,7 @@  project find it more convenient to use legacy encodings, Git
 does not forbid it.  However, there are a few things to keep in
 mind.
 
-. 'git commit' and 'git commit-tree' issue
+. `git commit` and `git commit-tree` issue
   a warning if the commit log message given to it does not look
   like a valid UTF-8 string, unless you explicitly say your
   project uses a legacy encoding.  The way to say this is to
@@ -50,7 +50,7 @@  of `i18n.commitEncoding` in their `encoding` header.  This is to
 help other people who look at them later.  Lack of this header
 implies that the commit log message is encoded in UTF-8.
 
-. 'git log', 'git show', 'git blame' and friends look at the
+. `git log`, `git show`, `git blame` and friends look at the
   `encoding` header of a commit object, and try to re-code the
   log message into UTF-8 unless otherwise specified.  You can
   specify the desired output encoding with
diff --git a/Documentation/signoff-option.txt b/Documentation/signoff-option.txt
index d98758f3cb7..cddfb225d1d 100644
--- a/Documentation/signoff-option.txt
+++ b/Documentation/signoff-option.txt
@@ -1,8 +1,8 @@ 
 ifdef::git-commit[]
--s::
+`-s`::
 endif::git-commit[]
---signoff::
---no-signoff::
+`--signoff`::
+`--no-signoff`::
 	Add a `Signed-off-by` trailer by the committer at the end of the commit
 	log message.  The meaning of a signoff depends on the project
 	to which you're committing.  For example, it may certify that
@@ -14,5 +14,5 @@  endif::git-commit[]
 	leadership of the project to which you're contributing to
 	understand how the signoffs are used in that project.
 +
-The --no-signoff option can be used to countermand an earlier --signoff
+The `--no-signoff` option can be used to countermand an earlier `--signoff`
 option on the command line.