[PATCH] docs: ja_JP: add guidance for the Fixes: tag in SubmittingPatches

[PATCH] docs: ja_JP: add guidance for the Fixes: tag in SubmittingPatches

[Akiyoshi Kurita]

The Japanese translation of SubmittingPatches was missing the section
describing the use of the 'Fixes:' tag. This patch adds the missing
description, aligning the translation with commit 8401aa1f5997
("Documentation/SubmittingPatches: describe the Fixes: tag") in the
English version.

Signed-off-by: Akiyoshi Kurita <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..28ad83171252 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``で問題を発見した場合）、
+少なくとも SHA-1 ID の最初の 12 文字と 1 行の要約を記載した「Fixes:」タグを使用してください。
+タグを複数行に分割しないでください。解析スクリプトを簡素化するため、タグは
+「75 文字で折り返す」ルールから除外されます。
+
+例:
+
+        Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
+
+以下の ``git config`` 設定を使用すると、``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) パッチの分割
 
-- 
2.47.3

Re: [PATCH] docs: ja_JP: add guidance for the Fixes: tag in SubmittingPatches

[Akira Yokosawa]

Hi Akiyoshi,

On Fri,  5 Sep 2025 12:27:29 +0900, Akiyoshi Kurita wrote:
> The Japanese translation of SubmittingPatches was missing the section
> describing the use of the 'Fixes:' tag. This patch adds the missing
> description, aligning the translation with commit 8401aa1f5997
> ("Documentation/SubmittingPatches: describe the Fixes: tag") in the
> English version.
> 
> Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>
> ---

This one made my imbox. Nice!

>  .../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..28ad83171252 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``で問題を発見した場合）、
> +少なくとも SHA-1 ID の最初の 12 文字と 1 行の要約を記載した「Fixes:」タグを使用してください。
> +タグを複数行に分割しないでください。解析スクリプトを簡素化するため、タグは
> +「75 文字で折り返す」ルールから除外されます。
> +
> +例:
> +
> +        Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
> +
> +以下の ``git config`` 設定を使用すると、``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) パッチの分割
>  

So, this doesn't cover the other hunks in commit 8401aa1f5997.
Instead, it includes the change made later in commit 5b5bbb8cc51be
("docs: process: Add an example for creating a fixes tag").

Your interpretation of Jon's desire might be different from that of
mine, but I think Jon suggested translating up-to-date
submitting-patches.rst as a whole.

Of course that would be great, but I'm not sure it is a reasonable ask
here.

I think covering both commits 8401aa1f5997 and 5b5bbb8cc51be might be
a reasonable middle ground here.

What do you think?

It's 100% up to you how far you want to do.

Thanks, Akira

Re: [PATCH] docs: ja_JP: add guidance for the Fixes: tag in SubmittingPatches

[weibu]

Hi Akira-san

Thanks—got it. I’ll take the middle ground you suggested.

For v2, I’ll cover both commits:

sync the “Fixes:” section and related wording from 8401aa1f5997, and

keep the example/pretty-format from 5b5bbb8cc51be.

I’ll keep v2 scoped to those hunks for an easier review. After that, I 
can follow up with a separate series to gradually sync the ja_JP file 
with the current English submitting-patches.rst.

Thanks,
Akiyoshi


2025-09-05 18:48 に Akira Yokosawa さんは書きました:
> Hi Akiyoshi,
> 
> On Fri,  5 Sep 2025 12:27:29 +0900, Akiyoshi Kurita wrote:
>> The Japanese translation of SubmittingPatches was missing the section
>> describing the use of the 'Fixes:' tag. This patch adds the missing
>> description, aligning the translation with commit 8401aa1f5997
>> ("Documentation/SubmittingPatches: describe the Fixes: tag") in the
>> English version.
>> 
>> Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>
>> ---
> 
> This one made my imbox. Nice!
> 
>>  .../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..28ad83171252 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``で問題を発見した場合）、
>> +少なくとも SHA-1 ID の最初の 12 文字と 1 行の要約を記載した「Fixes:」タグを使用してください。
>> +タグを複数行に分割しないでください。解析スクリプトを簡素化するため、タグは
>> +「75 文字で折り返す」ルールから除外されます。
>> +
>> +例:
>> +
>> +        Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() 
>> return the number of pages it actually freed")
>> +
>> +以下の ``git config`` 設定を使用すると、``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) パッチの分割
>> 
> 
> So, this doesn't cover the other hunks in commit 8401aa1f5997.
> Instead, it includes the change made later in commit 5b5bbb8cc51be
> ("docs: process: Add an example for creating a fixes tag").
> 
> Your interpretation of Jon's desire might be different from that of
> mine, but I think Jon suggested translating up-to-date
> submitting-patches.rst as a whole.
> 
> Of course that would be great, but I'm not sure it is a reasonable ask
> here.
> 
> I think covering both commits 8401aa1f5997 and 5b5bbb8cc51be might be
> a reasonable middle ground here.
> 
> What do you think?
> 
> It's 100% up to you how far you want to do.
> 
> Thanks, Akira

[PATCH v2] docs: ja_JP: SubmittingPatches: document the 'Fixes:' tag (+example)

[Akiyoshi Kurita]

Sync the ja_JP translation with parts of:
  - 8401aa1f5997 ("Documentation/SubmittingPatches: describe the Fixes: tag")
  - 5b5bbb8cc51be ("docs: process: Add an example for creating a fixes tag")

Link: https://lore.kernel.org/all/20250905032729.2284883-1-weibu@redadmin.org/
Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>

---
v2:
  - Add explanatory paragraphs from 8401aa1f5997 (purpose + stable note)
  - Keep example and pretty-format from 5b5bbb8cc51be
 Documentation/translations/ja_JP/SubmittingPatches | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/Documentation/translations/ja_JP/SubmittingPatches b/Documentation/translations/ja_JP/SubmittingPatches
index 28ad83171252..a05829427591 100644
--- a/Documentation/translations/ja_JP/SubmittingPatches
+++ b/Documentation/translations/ja_JP/SubmittingPatches
@@ -154,6 +154,18 @@ http://savannah.nongnu.org/projects/quilt
         $ git log -1 --pretty=fixes 54a4f0239f2e
         Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")
 
+
+「Fixes:」タグは、そのパッチが過去のコミットに起因する問題を修正していることを示します。
+このタグはバグの起源を特定しやすくし、バグ修正のレビューに役立ちます。
+また、このタグはどの安定版（stable）カーネルがあなたの修正を取り込むべきかを判断する際に、
+stable カーネルチームを支援します。パッチによって修正されるバグを示すための推奨される方法です。
+詳細は :ref:`describe_changes` を参照してください。
+
+注意: 「Fixes:」タグを付けても、stable カーネルの運用ルールの手続きを迂回するものではなく、
+stable の候補となるすべてのパッチに「Cc: stable@vger.kernel.org」を付けるという要件が
+置き換えられるわけではありません。詳しくは Documentation/process/stable-kernel-rules.rst を参照してください。
+
+
 3) パッチの分割
 
 意味のあるひとまとまりごとに変更を個々のパッチファイルに分けてください。
-- 
2.47.3

Re: [PATCH v2] docs: ja_JP: SubmittingPatches: document the 'Fixes:' tag (+example)

[Akira Yokosawa]

Hi,

On Fri,  5 Sep 2025 20:14:03 +0900, Akiyoshi Kurita wrote:
> Sync the ja_JP translation with parts of:
>   - 8401aa1f5997 ("Documentation/SubmittingPatches: describe the Fixes: tag")
>   - 5b5bbb8cc51be ("docs: process: Add an example for creating a fixes tag")

Consistent SHA-1 hash length would look nicer.

> 
> Link: https://lore.kernel.org/all/20250905032729.2284883-1-weibu@redadmin.org/

This link to v1 needs to be under the "---" below.

Wait, do you mean this patch is supposed to be applied on top of v1?

> Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>
> 
> ---
> v2:
>   - Add explanatory paragraphs from 8401aa1f5997 (purpose + stable note)
>   - Keep example and pretty-format from 5b5bbb8cc51be
>  Documentation/translations/ja_JP/SubmittingPatches | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 

I think I need to be more clear on what I am expecting.
I'll send a follow-up comment early next week.

Have a nice weekend!

Thanks,
Akira

Re: [PATCH v2] docs: ja_JP: SubmittingPatches: document the 'Fixes:' tag (+example)

[weibu]

Hi Akira-san,

Thank you very much for your review and detailed feedback.

I will update the Fixes: example to use a consistent 12-character SHA-1 
hash.

I will also move the Link: line under the --- separator, as per 
convention.

To clarify: v2 was intended as a full replacement of v1, not something 
to be applied on top of it. I’ll make that explicit in the changelog 
section for v3.

I’ll prepare and send a v3 patch early next week with these corrections.

Thanks again for your guidance, and have a good weekend.

Best regards,
Akiyoshi Kurita

2025-09-06 00:14 に Akira Yokosawa さんは書きました:
> Hi,
> 
> On Fri,  5 Sep 2025 20:14:03 +0900, Akiyoshi Kurita wrote:
>> Sync the ja_JP translation with parts of:
>>   - 8401aa1f5997 ("Documentation/SubmittingPatches: describe the 
>> Fixes: tag")
>>   - 5b5bbb8cc51be ("docs: process: Add an example for creating a fixes 
>> tag")
> 
> Consistent SHA-1 hash length would look nicer.
> 
>> 
>> Link: 
>> https://lore.kernel.org/all/20250905032729.2284883-1-weibu@redadmin.org/
> 
> This link to v1 needs to be under the "---" below.
> 
> Wait, do you mean this patch is supposed to be applied on top of v1?
> 
>> Signed-off-by: Akiyoshi Kurita <weibu@redadmin.org>
>> 
>> ---
>> v2:
>>   - Add explanatory paragraphs from 8401aa1f5997 (purpose + stable 
>> note)
>>   - Keep example and pretty-format from 5b5bbb8cc51be
>>  Documentation/translations/ja_JP/SubmittingPatches | 12 ++++++++++++
>>  1 file changed, 12 insertions(+)
>> 
> 
> I think I need to be more clear on what I am expecting.
> I'll send a follow-up comment early next week.
> 
> Have a nice weekend!
> 
> Thanks,
> Akira