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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <cbcc3317-958c-450d-afab-e9a29b1d5add@gmail.com>
Date: Fri, 5 Sep 2025 18:48:41 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Akiyoshi Kurita <weibu@...admin.org>
Cc: linux-kernel@...r.kernel.org, corbet@....net,
 Akira Yokosawa <akiyks@...il.com>, linux-doc@...r.kernel.org
Subject: Re: [PATCH] docs: ja_JP: add guidance for the Fixes: tag in
 SubmittingPatches

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@...admin.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