The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Akiyoshi Kurita <weibu@redadmin.org>
To: linux-doc@vger.kernel.org
Cc: corbet@lwn.net, akiyks@gmail.com, linux-kernel@vger.kernel.org,
	Akiyoshi Kurita <weibu@redadmin.org>
Subject: [PATCH v3] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag (12-char SHA-1 + pretty example)
Date: Tue,  9 Sep 2025 11:05:03 +0900	[thread overview]
Message-ID: <20250909020503.117265-1-weibu@redadmin.org> (raw)

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


                 reply	other threads:[~2025-09-09  2:05 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250909020503.117265-1-weibu@redadmin.org \
    --to=weibu@redadmin.org \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox