docs/ja_JP: submitting-patches: Amend "Describe your changes"

+53 -54

1 changed file

expand all

Documentation

translations

ja_JP

process

submitting-patches.rst

+53 -54

Documentation/translations/ja_JP/process/submitting-patches.rst

··· 55 55 変更内容を記述する 56 56 ------------------ 57 57 58 - 問題を記述してください。あなたのパッチが 1 行のバグ修正であっても、 58 + まず問題点を記べてください。あなたのパッチが 1 行のバグ修正であっても、 59 59 5000 行の新機能であっても、それを行う動機となった根本的な問題が 60 - 必ずあるはずです。修正すべき価値のある問題が存在し、レビューアが 61 - 最初の段落以降を読む意味があることを納得させてください。 60 + 必ずあるはずです。レビューアが、修正すべき問題がたしかに存在し、冒頭の 61 + 段落の続きを読むべきだと納得できるように書いてください。 62 62 63 - ユーザーから見える影響を記述してください。クラッシュやロックアップは 63 + 次にユーザーから見える影響を記述してください。クラッシュやロックアップは 64 64 分かりやすいですが、すべてのバグがそこまで露骨とは限りません。 65 65 たとえコードレビュー中に見つかった問題であっても、ユーザーに 66 66 どのような影響があり得るかを記述してください。 67 67 Linux の多くの環境は、上流から特定のパッチだけを取り込む二次的な 68 68 安定版ツリーや、ベンダー／製品固有のツリーのカーネルで動いています。 69 - したがって、変更を下流へ適切に流す助けになる情報（発生条件、dmesg 69 + したがって、変更を適切に下流へ流す助けになる情報（発生条件、dmesg 70 70 の抜粋、クラッシュ内容、性能劣化、レイテンシのスパイク、 71 71 ロックアップ等）があれば記載してください。 72 72 73 - 最適化とトレードオフを定量的に示してください。パフォーマンス、 73 + 次に最適化とトレードオフを定量的に示してください。パフォーマンス、 74 74 メモリ消費量、スタックフットプリント、バイナリサイズの改善を主張する 75 75 場合は、それを裏付ける数値を記載してください。 76 - また、目に見えないコストについても記述してください。最適化は通常 77 - 無料ではなく、CPU・メモリ・可読性の間でのトレードオフになります。 78 - ヒューリスティクスの場合は、異なるワークロード間でのトレードオフに 76 + また、目に見えないコストについても記述してください。多くの場合、 77 + 最適化は CPU・メモリ・可読性の間でのトレードオフとなります。 78 + ヒューリスティクスの場合は、異なるワークロード間でのトレードオフと 79 79 なります。レビューアがコストとメリットを比較検討できるよう、 80 - 最適化によって予想されるデメリットも記述してください。 80 + 最適化に伴って想定されるデメリットも記述してください。 81 81 82 - 問題を明確にできたら、実際にどのような対策を講じているかを技術的に 83 - 詳しく記述してください。レビューアがコードが意図したとおりに動作して 84 - いるかを確認できるよう、変更内容を平易な言葉で書き下すことが重要です。 82 + 問題点の明確化が済んだら、実際にどのような対策を講じているかを技術的に 83 + 詳しく説明してください。コードが意図したとおりに動作していることを 84 + レビューアが確認できるよう、変更内容を平易な言葉で書き下すことが重要です。 85 85 86 - パッチ説明を Linux のソースコード管理システム ``git`` の 87 - 「コミットログ」としてそのまま取り込める形で書けば、メンテナは 88 - 助かります。詳細は原文の該当節を参照してください。 86 + パッチの説明が Linux のソースコード管理システム ``git`` の「コミットログ」 87 + としてそのまま取り込める形で書かれていれば、メンテナは助かります。 88 + 詳細は原文の該当節 ("The canonical patch format") を参照してください。 89 89 90 90 .. TODO: Convert to file-local cross-reference when the destination is 91 91 translated. 92 92 93 93 1 つのパッチでは 1 つの問題だけを解決してください。記述が長くなり 94 - 始めたら、パッチを分割すべきサインです。詳細は原文の該当節を参照 95 - してください。 94 + 始めたら、それはパッチを分割すべきサインです。 95 + 詳細は原文の該当節 ("Separate your changes") を参照してください。 96 96 97 97 .. TODO: Convert to file-local cross-reference when the destination is 98 98 translated. 99 99 100 100 パッチまたはパッチシリーズを投稿／再投稿する際は、その完全な 101 - 説明と、それを正当化する理由を含めてください。単に、これが 102 - パッチ（シリーズ）のバージョン N であるとだけ書かないでください。 103 - サブシステムメンテナが以前のパッチ版や参照先 URL をさかのぼって 104 - パッチ説明を探し、それをパッチに補うことを期待してはいけません。 101 + 説明と、それを正当化する理由を含めてください。単に「これはパッチ 102 + （シリーズ）のバージョン N です」とだけ書くのは避けてください。 103 + サブシステムメンテナが以前のパッチバージョンや参照先 URL をさかのぼって 104 + パッチ記述を探し、それをパッチに補うことを期待してはいけません。 105 105 つまり、パッチ（シリーズ）とその説明は、それだけで完結しているべき 106 106 です。これはメンテナとレビューアの双方に有益です。レビューアの 107 - 中には、以前のパッチ版を受け取っていない人もいるでしょう。 107 + 中には、以前のパッチバージョンを受け取っていない人もいるでしょう。 108 108 109 - 変更内容は命令形で記述してください。たとえば、 110 - 「make xyzzy do frotz」とし、 111 - 「[This patch] makes xyzzy do frotz」や 112 - 「[I] changed xyzzy to do frotz」 113 - のようには書かないでください。あたかもコードベースに対して、 114 - その振る舞いを変えるよう命令しているかのように書いてください。 109 + 変更内容は、あたかもコードベースに対してその振る舞いを変えるように 110 + 命令するかの如く、（訳補: 英語の）命令形で記述してください。たとえば、 111 + "[This patch] makes xyzzy do frotz" や 112 + "[I] changed xyzzy to do frotz" のような言い回しを避け、 113 + "make xyzzy do frotz" のように書いてください。 115 114 116 - 特定のコミットに言及したい場合は、コミットの SHA-1 ID だけを 117 - 書かないでください。レビューアがそれが何についてのものかを 118 - 把握しやすくなるよう、コミットの 1 行要約も含めてください。例:: 115 + 特定のコミットに言及したい場合に、コミットの SHA-1 ID だけを 116 + 書くのは避けてください。レビューアがそれが何についてのものかを 117 + 把握しやすいよう、コミットの 1 行要約も含めてください。例:: 119 118 120 119 Commit e21d2170f36602ae2708 ("video: remove unnecessary 121 120 platform_set_drvdata()") removed the unnecessary ··· 122 123 delete it. 123 124 124 125 また、SHA-1 ID は少なくとも先頭 12 文字を使うようにしてください。 125 - カーネルのリポジトリには非常に多くのオブジェクトがあるため、 126 - それより短い ID では衝突が現実に起こり得ます。いま 6 文字の ID に 127 - 衝突がなくても、5 年後もそうだとは限らないことに注意してください。 126 + カーネルのリポジトリには\ **非常に多くの**\ オブジェクトがあるため、 127 + それより短い ID では衝突が現実問題となります。6 文字の ID が今現在 128 + 衝突しないからといって、5 年後もそうであるとは限らないことを念頭に 129 + 置いてください。 128 130 129 131 変更に関連する議論や、その背景情報が Web 上で参照できる場合は、 130 - それを指す ``Link:`` タグを追加してください。パッチが過去の 131 - メーリングリストでの議論や、Web に記録された何かの結果であるなら、 132 + それを指す 'Link:' タグを追加してください。過去のメーリングリスト 133 + での議論や、Web に記録された何かに由来するパッチならば、 132 134 それを示してください。 133 135 134 - メーリングリストのアーカイブへリンクする場合は、できれば 135 - lore.kernel.org のメッセージアーカイブサービスを使ってください。 136 - リンク URL を作るには、そのメッセージの ``Message-ID`` ヘッダの内容 137 - から、前後の山括弧を取り除いたものを使います。例:: 136 + メーリングリストのアーカイブへリンクする場合は、できれば lore.kernel.org 137 + のメッセージアーカイブサービスを使ってください。リンク URL を作るには、 138 + そのメッセージの ``Message-ID`` ヘッダの内容から、前後の山括弧を取り除いた 139 + ものを使います。例:: 138 140 139 141 Link: https://lore.kernel.org/30th.anniversary.repost@klaava.Helsinki.FI 140 142 141 143 実際にリンクが機能し、該当するメッセージを指していることを 142 - 確認してください。ただし、外部リソースを見なくても説明が理解できる 143 - ようにするよう努めてください。 144 + 確認してください。 144 145 146 + ただし、外部リソースを見なくても説明が理解できるようにするよう努めてください。 145 147 メーリングリストのアーカイブやバグへの URL を示すだけでなく、 146 - 投稿されたパッチに至った議論の要点も要約してください。 148 + 投稿されたパッチに至った議論のポイントも要約してください。 147 149 148 150 パッチがバグを修正するものであれば、メーリングリストのアーカイブや 149 151 公開バグトラッカー上の報告を指す URL を付けて、``Closes:`` タグを ··· 153 153 Closes: https://example.com/issues/1234 154 154 155 155 このようなタグ付きのコミットが適用されたとき、自動的に issue を 156 - 閉じられるバグトラッカーもあります。メーリングリストを監視している 156 + 閉じるバグトラッカーもあります。メーリングリストを監視している 157 157 ボットの中には、そのようなタグを追跡して一定の動作を行うものも 158 - あります。非公開のバグトラッカーや無効な URL は禁止です。 158 + あります。ただし、非公開バグトラッカーの（訳補: 部外者が）閲覧できない 159 + URL は禁止です。 159 160 160 - パッチが特定のコミットに含まれるバグを修正するものであれば、 161 - たとえば ``git bisect`` で問題を見つけた場合には、SHA-1 ID の 162 - 先頭少なくとも 12 文字と 1 行要約を含めて、``Fixes:`` タグを 161 + パッチが特定のコミットに含まれるバグを修正するもの、たとえば 162 + ``git bisect`` で問題を見つけたものの場合には、SHA-1 ID の 163 + 先頭少なくとも 12 文字と 1 行要約を含めて 'Fixes:' タグを 163 164 使ってください。タグを複数行に分割してはいけません。タグは 164 165 解析スクリプトを単純にするため、「75 桁で折り返す」規則の 165 - 例外です。 166 - 167 - 例:: 166 + 例外です。例:: 168 167 169 168 Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed") 170 169 171 - 上の形式を ``git log`` や ``git show`` で出力しやすくするために、 172 - 次の ``git config`` 設定を使えます:: 170 + ``git log`` や ``git show`` の出力を上の形式で整形させるには、 171 + 次の ``git config`` 設定が使えます:: 173 172 174 173 [core] 175 174 abbrev = 12

Configure Feed

Configure Feed