[PATCH v4] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag (12-char SHA-1 + pretty example)

[PATCH v4] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag (12-char SHA-1 + pretty example)

[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>

---
v4:
  - Fix unnatural Japanese wording in the new Fixes: section for clarity.
  - No content change, only Japanese expression improved.
  - v4 fully replaces v3 (not incremental).

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

diff --git a/Documentation/translations/ja_JP/SubmittingPatches b/Documentation/translations/ja_JP/SubmittingPatches
index 1d1e9622eafe..65dc5f87351f 100644
--- a/Documentation/translations/ja_JP/SubmittingPatches
+++ b/Documentation/translations/ja_JP/SubmittingPatches
@@ -134,8 +134,8 @@ http://savannah.nongnu.org/projects/quilt
 
 特定のコミットで導入された不具合を修正するパッチである場合（例えば ``git bisect`` で
 問題の導入コミットを特定した場合など）、そのコミットを指し示すために「Fixes:」タグを
-使用してください。下流の -stable 系列での自動ピックアップにも利用されるため、**正確な**
-コミット ID と **1 行の要約**を記載することが重要です。
+使用してください。下流の -stable 系列での自動ピックアップにも利用されるため正確な
+コミットIDと1行の要約を記載することが重要です。
 
 書式（SHA-1 は短縮 12 文字に統一）::
 
-- 
2.47.3

Re: [PATCH v4] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag (12-char SHA-1 + pretty example)

[Akira Yokosawa]

On Tue,  9 Sep 2025 11:25:02 +0900, Akiyoshi Kurita wrote:
> 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>
> 
> ---
> v4:
>   - Fix unnatural Japanese wording in the new Fixes: section for clarity.
>   - No content change, only Japanese expression improved.
>   - v4 fully replaces v3 (not incremental).

Sorry, but this is wrong. I needed to apply v4 on top of v3.

It is contributor's responsibility to make reviewers life easier,
Please be careful.

I think you need to understand Linux kernel's patch submission
conventions before starting sending patches.

Of course, submitting-patches.rst (or ja_JP's SubmittingPatches) should
be a good starting point for learning the process.  

Probably, it would be better for you to send your WIP patches privately
(meaning without CCs) to me.  Not necessarily in English.

Regards,
Akira

[PATCH v5] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag

[Akiyoshi Kurita]

Sync the ja_JP translation with the following upstream commits:

commit 8401aa1f5997 ("Documentation/SubmittingPatches: describe the Fixes: tag")
commit 19c3fe285cba ("docs: Explicitly state that the 'Fixes:' tag shouldn't split lines")
commit 5b5bbb8cc51b ("docs: process: Add an example for creating a fixes tag")
commit 6356f18f09dc ("Align git commit ID abbreviation guidelines and checks")

The mix of plain text and reST markup for ``git bisect`` is intentional to
align with the eventual reST conversion.

Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>
---
v5:
 - whole rewrite
---
 .../translations/ja_JP/SubmittingPatches      | 28 ++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/Documentation/translations/ja_JP/SubmittingPatches b/Documentation/translations/ja_JP/SubmittingPatches
index 5334db471744..b950347b5993 100644
--- a/Documentation/translations/ja_JP/SubmittingPatches
+++ b/Documentation/translations/ja_JP/SubmittingPatches
@@ -132,6 +132,25 @@ http://savannah.nongnu.org/projects/quilt
        platform_set_drvdata(), but left the variable "dev" unused,
        delete it.
 
+特定のコミットで導入された不具合を修正する場合（例えば ``git bisect`` で原因となった
+コミットを特定したときなど）は、コミットの SHA-1 の先頭12文字と1行の要約を添えた
+「Fixes:」タグを付けてください。この行は75文字を超えても構いませんが、途中で
+改行せず、必ず1行で記述してください。
+例:
+        Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
+
+以下の git の設定を使うと、git log や git show で上記形式を出力するための
+専用の出力形式を追加できます::
+
+        [core]
+                abbrev = 12
+        [pretty]
+                fixes = Fixes: %h (\"%s\")
+
+使用例::
+
+        $ git log -1 --pretty=fixes 54a4f0239f2e
+        Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
 
 3) パッチの分割
 
@@ -409,7 +428,7 @@ Acked-by: が必ずしもパッチ全体の承認を示しているわけでは
 このタグはパッチに関心があると思われる人達がそのパッチの議論に含まれていたこと
 を明文化します。
 
-14) Reported-by:, Tested-by:, Reviewed-by: および Suggested-by: の利用
+14) Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: および Fixes: の利用
 
 他の誰かによって報告された問題を修正するパッチであれば、問題報告者という寄与を
 クレジットするために、Reported-by: タグを追加することを検討してください。
@@ -465,6 +484,13 @@ Suggested-by: タグは、パッチのアイデアがその人からの提案に
 クレジットしていけば、望むらくはその人たちが将来別の機会に再度力を貸す気に
 なってくれるかもしれません。
 
+Fixes: タグは、そのパッチが以前のコミットにあった問題を修正することを示します。
+これは、バグがどこで発生したかを特定しやすくし、バグ修正のレビューに役立ちます。
+また、このタグはstableカーネルチームが、あなたの修正をどのstableカーネル
+バージョンに適用すべきか判断する手助けにもなります。パッチによって修正された
+バグを示すには、この方法が推奨されます。前述の、「2) パッチに対する説明」の
+セクションを参照してください。
+
 15) 標準的なパッチのフォーマット
 
 標準的なパッチのサブジェクトは以下のとおりです。
-- 
2.47.3

Re: [PATCH v5] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag

[Akira Yokosawa]

[+CC: Shibata-san]

On 9/25/25 04:24, Akiyoshi Kurita wrote:
> Sync the ja_JP translation with the following upstream commits:
> 
> commit 8401aa1f5997 ("Documentation/SubmittingPatches: describe the Fixes: tag")
> commit 19c3fe285cba ("docs: Explicitly state that the 'Fixes:' tag shouldn't split lines")
> commit 5b5bbb8cc51b ("docs: process: Add an example for creating a fixes tag")
> commit 6356f18f09dc ("Align git commit ID abbreviation guidelines and checks")
> 
> The mix of plain text and reST markup for ``git bisect`` is intentional to
> align with the eventual reST conversion.
> 
> Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>
> ---
> v5:
>  - whole rewrite

This looks good to me.  Thank you!

Reviewed-by: Akira Yokosawa <akiyks@gmail.com>

You are lucky in that those four changes related to the Fixes: tag are
pretty much localized in the English version, across the conversion to
reST.  With regards to "Fixes:", ja_JP/SubmittingPatches should be
up-to-date by this change. 

Regards,
Akira

> ---
>  .../translations/ja_JP/SubmittingPatches      | 28 ++++++++++++++++++-
>  1 file changed, 27 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/translations/ja_JP/SubmittingPatches b/Documentation/translations/ja_JP/SubmittingPatches
> index 5334db471744..b950347b5993 100644
> --- a/Documentation/translations/ja_JP/SubmittingPatches
> +++ b/Documentation/translations/ja_JP/SubmittingPatches
> @@ -132,6 +132,25 @@ http://savannah.nongnu.org/projects/quilt
>         platform_set_drvdata(), but left the variable "dev" unused,
>         delete it.
>  
> +特定のコミットで導入された不具合を修正する場合（例えば ``git bisect`` で原因となった
> +コミットを特定したときなど）は、コミットの SHA-1 の先頭12文字と1行の要約を添えた
> +「Fixes:」タグを付けてください。この行は75文字を超えても構いませんが、途中で
> +改行せず、必ず1行で記述してください。
> +例:
> +        Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
> +
> +以下の git の設定を使うと、git log や git show で上記形式を出力するための
> +専用の出力形式を追加できます::
> +
> +        [core]
> +                abbrev = 12
> +        [pretty]
> +                fixes = Fixes: %h (\"%s\")
> +
> +使用例::
> +
> +        $ git log -1 --pretty=fixes 54a4f0239f2e
> +        Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
>  
>  3) パッチの分割
>  
> @@ -409,7 +428,7 @@ Acked-by: が必ずしもパッチ全体の承認を示しているわけでは
>  このタグはパッチに関心があると思われる人達がそのパッチの議論に含まれていたこと
>  を明文化します。
>  
> -14) Reported-by:, Tested-by:, Reviewed-by: および Suggested-by: の利用
> +14) Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: および Fixes: の利用
>  
>  他の誰かによって報告された問題を修正するパッチであれば、問題報告者という寄与を
>  クレジットするために、Reported-by: タグを追加することを検討してください。
> @@ -465,6 +484,13 @@ Suggested-by: タグは、パッチのアイデアがその人からの提案に
>  クレジットしていけば、望むらくはその人たちが将来別の機会に再度力を貸す気に
>  なってくれるかもしれません。
>  
> +Fixes: タグは、そのパッチが以前のコミットにあった問題を修正することを示します。
> +これは、バグがどこで発生したかを特定しやすくし、バグ修正のレビューに役立ちます。
> +また、このタグはstableカーネルチームが、あなたの修正をどのstableカーネル
> +バージョンに適用すべきか判断する手助けにもなります。パッチによって修正された
> +バグを示すには、この方法が推奨されます。前述の、「2) パッチに対する説明」の
> +セクションを参照してください。
> +
>  15) 標準的なパッチのフォーマット
>  
>  標準的なパッチのサブジェクトは以下のとおりです。

Re: [PATCH v5] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag

[Jonathan Corbet]

Akiyoshi Kurita <weibu@redadmin.org> writes:

> Sync the ja_JP translation with the following upstream commits:
>
> commit 8401aa1f5997 ("Documentation/SubmittingPatches: describe the Fixes: tag")
> commit 19c3fe285cba ("docs: Explicitly state that the 'Fixes:' tag shouldn't split lines")
> commit 5b5bbb8cc51b ("docs: process: Add an example for creating a fixes tag")
> commit 6356f18f09dc ("Align git commit ID abbreviation guidelines and checks")
>
> The mix of plain text and reST markup for ``git bisect`` is intentional to
> align with the eventual reST conversion.
>
> Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>
> ---
> v5:
>  - whole rewrite
> ---
>  .../translations/ja_JP/SubmittingPatches      | 28 ++++++++++++++++++-
>  1 file changed, 27 insertions(+), 1 deletion(-)

Applied.

That said ... this is not an RST file, and won't be pulled into the docs
build.  I would *love* to see a patch that moves this file into its
proper location under .../process/ and brings it into the build.

Thanks,

jon

Re: [PATCH v5] docs: ja_JP: SubmittingPatches: describe the 'Fixes:' tag

[weibu]

Thanks, I’ll follow up by moving this under 
.../translations/ja_JP/process/, converting it to RST, and wiring it 
into the Sphinx toctree so it’s built.

2025-10-15 00:02 に Jonathan Corbet さんは書きました:
> Akiyoshi Kurita <weibu@redadmin.org> writes:
> 
>> Sync the ja_JP translation with the following upstream commits:
>> 
>> commit 8401aa1f5997 ("Documentation/SubmittingPatches: describe the 
>> Fixes: tag")
>> commit 19c3fe285cba ("docs: Explicitly state that the 'Fixes:' tag 
>> shouldn't split lines")
>> commit 5b5bbb8cc51b ("docs: process: Add an example for creating a 
>> fixes tag")
>> commit 6356f18f09dc ("Align git commit ID abbreviation guidelines and 
>> checks")
>> 
>> The mix of plain text and reST markup for ``git bisect`` is 
>> intentional to
>> align with the eventual reST conversion.
>> 
>> Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>
>> ---
>> v5:
>>  - whole rewrite
>> ---
>>  .../translations/ja_JP/SubmittingPatches      | 28 
>> ++++++++++++++++++-
>>  1 file changed, 27 insertions(+), 1 deletion(-)
> 
> Applied.
> 
> That said ... this is not an RST file, and won't be pulled into the 
> docs
> build.  I would *love* to see a patch that moves this file into its
> proper location under .../process/ and brings it into the build.
> 
> Thanks,
> 
> jon