The Linux Kernel Mailing List
 help / color / mirror / Atom feed
* [PATCH v3] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag (12-char SHA-1 + pretty example)
@ 2025-09-09  2:05 Akiyoshi Kurita
  0 siblings, 0 replies; only message in thread
From: Akiyoshi Kurita @ 2025-09-09  2:05 UTC (permalink / raw)
  To: linux-doc; +Cc: corbet, akiyks, linux-kernel, Akiyoshi Kurita

Add a Japanese section describing the Fixes: tag, use a consistent
12-character SHA-1 in the example, and include the pretty-format
snippet to generate a Fixes: line with git log/show.
No functional changes.

Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>

---
v3:
  - Cover both 8401aa1f5997 (description/purpose) and
    5b5bbb8cc51be (pretty format example).
  - Use 12-character SHA-1 consistently in examples.
  - v3 fully replaces v2 (not incremental).

Link: https://lore.kernel.org/all/20250905032729.2284883-1-weibu@redadmin.org/
---
---
 .../translations/ja_JP/SubmittingPatches      | 21 +++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/Documentation/translations/ja_JP/SubmittingPatches b/Documentation/translations/ja_JP/SubmittingPatches
index 5334db471744..1d1e9622eafe 100644
--- a/Documentation/translations/ja_JP/SubmittingPatches
+++ b/Documentation/translations/ja_JP/SubmittingPatches
@@ -132,6 +132,27 @@ http://savannah.nongnu.org/projects/quilt
        platform_set_drvdata(), but left the variable "dev" unused,
        delete it.
 
+特定のコミットで導入された不具合を修正するパッチである場合(例えば ``git bisect`` で
+問題の導入コミットを特定した場合など)、そのコミットを指し示すために「Fixes:」タグを
+使用してください。下流の -stable 系列での自動ピックアップにも利用されるため、**正確な**
+コミット ID と **1 行の要約**を記載することが重要です。
+
+書式(SHA-1 は短縮 12 文字に統一)::
+
+        Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()")
+
+以下の git-config を設定すると、上記スタイルの行を ``git log`` や ``git show`` で
+出力するためのプリティフォーマットを追加できます::
+
+        [core]
+                abbrev = 12
+        [pretty]
+                fixes = Fixes: %h (\"%s\")
+
+呼び出し例::
+
+        $ git log -1 --pretty=fixes e21d2170f366
+        Fixes: e21d2170f366 ("video: remove unnecessary platform_set_drvdata()")
 
 3) パッチの分割
 
-- 
2.47.3


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2025-09-09  2:05 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-09  2:05 [PATCH v3] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag (12-char SHA-1 + pretty example) Akiyoshi Kurita

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox