git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com>
Date
Jan 15, 2025, 20:23 UTC
Message-ID
<28316a709da913c624873291d96ed5aeddc6fc90.1736972628.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.1845.v2.git.1736972628.gitgitgadget@gmail.com>
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(-)
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.
-- 
gitgitgadget
Previous: Junio C HamanoNext: Patrick Steinhardt
Message 14 of 15 in “Doc git commit”
  1. 0/3 Doc git commitJean-Noël Avila via GitGitGadget, Jan 3, 2025
  2. 2/3 doc: git-commit.txt: convert git commit config to new formatJean-Noël Avila via GitGitGadget, Jan 3, 2025
  3. 1/3 doc: git-commit: apply new documentation guidelinesJean-Noël Avila via GitGitGadget, Jan 3, 2025
  4. Patrick SteinhardtJan 6, 2025
  5. Jean-Noël AVILAJan 7, 2025
  6. 3/3 doc: git-commit: migrate secondary files to new formatJean-Noël Avila via GitGitGadget, Jan 3, 2025
  7. 0/5 Doc git commitJean-Noël Avila via GitGitGadget, Jan 15, 2025
  8. 1/5 doc: apply new documentation guidelines to git commitJean-Noël Avila via GitGitGadget, Jan 15, 2025
  9. Junio C HamanoJan 15, 2025
  10. 2/5 doc: the mode param of -u of git commit is optionalJean-Noël Avila via GitGitGadget, Jan 15, 2025
  11. 3/5 doc: make more direct explanations in git commit optionsJean-Noël Avila via GitGitGadget, Jan 15, 2025
  12. 4/5 doc: convert git commit config to new formatJean-Noël Avila via GitGitGadget, Jan 15, 2025
  13. Junio C HamanoJan 15, 2025
  14. 5/5 doc: migrate git-commit manpage secondary files to new formatJean-Noël Avila via GitGitGadget, Jan 15, 2025
  15. Patrick SteinhardtJan 16, 2025

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.