Commit 991dabb2 authored by Akira Yokosawa's avatar Akira Yokosawa Committed by Jonathan Corbet
Browse files

docs/ja_JP: Convert SubmitChecklist into reST with belated updates 



This is a brand-new translation against
commit 2783096f ("docs: submit-checklist: Expand on build tests
against different word sizes"), rather than an update of
ja_JP/SubmitChecklist, which has never updated since 2008 except for
trivial changes not involving translation.

As we now have two reST contents under the ja_JP translation,
to avoid duplicated boiler plates, split out ja_JP's own disclaimer
part into a new section and put a reference to it at the beginning of
each doc.

As there is no prospect of ja_JP to have a lot of translated docs,
keep those .rst files in the toctree of ja_JP/index.rst.

Signed-off-by: default avatarAkira Yokosawa <akiyks@gmail.com>
Cc: Tsugikazu Shibata <shibata@linuxfoundation.org>
Reviewed-by: default avatarTsugikazu Shibata <shibata@linuxfoundation.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250217060132.64670-1-akiyks@gmail.com
parent 56f2399f

Documentation/translations/ja_JP/SubmitChecklist

deleted100644 → 0
+0 −105
Original line number Diff line number Diff line 
NOTE:

This is a version of Documentation/process/submit-checklist.rst into Japanese.

This document is maintained by Takenori Nagano <t-nagano@ah.jp.nec.com>

and the JF Project team <http://www.linux.or.jp/JF/>.

If you find any difference between this document and the original file

or a problem with the translation,

please contact the maintainer of this file or JF project.



Please also note that the purpose of this file is to be easier to read

for non English (read: Japanese) speakers and is not intended as a

fork. So if you have any comments or updates of this file, please try

to update the original English file first.



Last Updated: 2008/07/14

==================================

これは、

linux-2.6.26/Documentation/process/submit-checklist.rst の和訳です。



翻訳団体： JF プロジェクト < http://www.linux.or.jp/JF/ >

翻訳日： 2008/07/14

翻訳者： Takenori Nagano <t-nagano at ah dot jp dot nec dot com>

校正者： Masanori Kobayashi さん <zap03216 at nifty dot ne dot jp>

==================================





Linux カーネルパッチ投稿者向けチェックリスト

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



本書では、パッチをより素早く取り込んでもらいたい開発者が実践すべき基本的な事柄

をいくつか紹介します。ここにある全ての事柄は、Documentation/process/submitting-patches.rst

などのLinuxカーネルパッチ投稿に際しての心得を補足するものです。



 1: 妥当なCONFIGオプションや変更されたCONFIGオプション、つまり =y, =m, =n

    全てで正しくビルドできることを確認してください。その際、gcc及びリンカが

    warningやerrorを出していないことも確認してください。



 2: allnoconfig, allmodconfig オプションを用いて正しくビルドできることを

    確認してください。



 3: 手許のクロスコンパイルツールやOSDLのPLMのようなものを用いて、複数の

    アーキテクチャにおいても正しくビルドできることを確認してください。



 4: 64bit長の'unsigned long'を使用しているppc64は、クロスコンパイルでの

    チェックに適当なアーキテクチャです。



 5: カーネルコーディングスタイルに準拠しているかどうか確認してください(!)



 6: CONFIGオプションの追加・変更をした場合には、CONFIGメニューが壊れていない

    ことを確認してください。



 7: 新しくKconfigのオプションを追加する際には、必ずそのhelpも記述してください。



 8: 適切なKconfigの依存関係を考えながら慎重にチェックしてください。

    ただし、この作業はマシンを使ったテストできちんと行うのがとても困難です。

    うまくやるには、自分の頭で考えることです。



 9: sparseを利用してちゃんとしたコードチェックをしてください。



10: 'make checkstack' を利用し、問題が発見されたら修正してください。

    'make checkstack' は明示的に問題を示しませんが、どれか

    １つの関数が512バイトより大きいスタックを使っていれば、修正すべき候補と

    なります。



11: グローバルなkernel API を説明する kernel-doc をソースの中に含めてください。

    ( staticな関数においては必須ではありませんが、含めてもらっても結構です )

    そして、'make htmldocs' もしくは 'make mandocs' を利用して追記した

    ドキュメントのチェックを行い、問題が見つかった場合には修正を行ってください。



12: CONFIG_PREEMPT, CONFIG_DEBUG_PREEMPT, CONFIG_DEBUG_SLAB,

    CONFIG_DEBUG_PAGEALLOC, CONFIG_DEBUG_MUTEXES, CONFIG_DEBUG_SPINLOCK,

    CONFIG_DEBUG_ATOMIC_SLEEP これら全てを同時に有効にして動作確認を

    行ってください。



13: CONFIG_SMP, CONFIG_PREEMPT を有効にした場合と無効にした場合の両方で

    ビルドした上、動作確認を行ってください。



14: lockdepの機能を全て有効にした上で、全てのコードパスを評価してください。



15: /proc に新しいエントリを追加した場合には、Documentation/ 配下に

    必ずドキュメントを追加してください。



16: 新しいブートパラメータを追加した場合には、

    必ずDocumentation/admin-guide/kernel-parameters.rst に説明を追加してください。



17: 新しくmoduleにパラメータを追加した場合には、MODULE_PARM_DESC()を

    利用して必ずその説明を記述してください。



18: 新しいuserspaceインタフェースを作成した場合には、Documentation/ABI/ に

    Documentation/ABI/README を参考にして必ずドキュメントを追加してください。



19: 少なくともslabアロケーションとpageアロケーションに失敗した場合の

    挙動について、fault-injectionを利用して確認してください。

    Documentation/fault-injection/ を参照してください。



    追加したコードがかなりの量であったならば、サブシステム特有の

    fault-injectionを追加したほうが良いかもしれません。



20: 新たに追加したコードは、`gcc -W'でコンパイルしてください。

    このオプションは大量の不要なメッセージを出力しますが、

    "warning: comparison between signed and unsigned" のようなメッセージは、

    バグを見つけるのに役に立ちます。



21: 投稿したパッチが -mm パッチセットにマージされた後、全ての既存のパッチや

    VM, VFS およびその他のサブシステムに関する様々な変更と、現時点でも共存

    できることを確認するテストを行ってください。

Documentation/translations/ja_JP/disclaimer-ja_JP.rst

0 → 100644
+24 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



.. _translations_ja_JP_disclaimer:



==========================

免責条項 (Disclaimer) 抄訳

==========================



.. note:: 【訳註】

   この文書は、

   :ref:`Disclaimer (英語版) <translations_disclaimer>`

   の一部を翻訳したものです。全文は英語版を参照願います。



Documentation/translations/ja_JP/ 以下のファイルは、対応する

Documentation/ 以下のファイル (原文) の日本語訳です。

翻訳と原文との違いや翻訳上の問題を見つけたら、

MAINTAINERS に記載の維持管理者に知らせてください。

翻訳が原文の更新に追いついていない場合は、それを日本語版に反映するパッチの

投稿も歓迎です。



なお、この翻訳の目的は非英語 (ここでは日本語) 話者への便宜提供であり、

フォークを意図したものではない事を念頭においてください。したがって、

このファイルの内容に対するコメントや更新すべきことがあれば、先に原文の

更新を検討してください。

Documentation/translations/ja_JP/index.rst

+2 −0
Original line number Diff line number Diff line
@@ -11,7 +11,9 @@ 
.. toctree::

   :maxdepth: 1



   disclaimer-ja_JP

   process/howto

   process/submit-checklist



.. raw:: latex

Documentation/translations/ja_JP/process/howto.rst

+10 −27
Original line number Diff line number Diff line 
.. raw:: latex

.. SPDX-License-Identifier: GPL-2.0



	\kerneldocCJKoff

.. Originally contributed by Tsugikazu Shibata



NOTE:

This is a version of Documentation/process/howto.rst translated into Japanese.

This document is maintained by Tsugikazu Shibata <tshibata@ab.jp.nec.com>

If you find any difference between this document and the original file or

a problem with the translation, please contact the maintainer of this file.



Please also note that the purpose of this file is to be easier to

read for non English (read: Japanese) speakers and is not intended as

a fork. So if you have any comments or updates for this file, please

try to update the original English file first.



----------------------------------



.. raw:: latex



	\kerneldocCJKon

Linux カーネル開発のやり方

==========================



.. note:: 【訳註】

   この文書は、

   Documentation/process/howto.rst

の和訳です。



翻訳者： Tsugikazu Shibata <tshibata@ab.jp.nec.com>



----------------------------------



Linux カーネル開発のやり方

==========================

   の翻訳です。

   免責条項については、

   :ref:`免責条項の抄訳 <translations_ja_JP_disclaimer>` および、

   :ref:`Disclaimer (英語版) <translations_disclaimer>` を参照してください。



これは上のトピック( Linux カーネル開発のやり方)の重要な事柄を網羅した

ドキュメントです。ここには Linux カーネル開発者になるための方法とLinux

Documentation/translations/ja_JP/process/submit-checklist.rst

0 → 100644
+162 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



.. Translated by Akira Yokosawa <akiyks@gmail.com>



.. An old translation of this document of a different origin was at

   Documentation/translations/ja_JP/SubmitChecklist, which can be found

   in the pre-v6.14 tree if you are interested.

   Please note that this translation is independent of the previous one.



======================================

Linux カーネルパッチ投稿チェックリスト

======================================



.. note:: 【訳註】

   この文書は、

   Documentation/process/submit-checklist.rst

   の翻訳です。

   免責条項については、

   :ref:`免責条項の抄訳 <translations_ja_JP_disclaimer>` および、

   :ref:`Disclaimer (英語版) <translations_disclaimer>` を参照してください。



以下は、カーネルパッチの投稿時に、そのスムーズな受け入れのために心がける

べき基本的な事項です。



これは、 Documentation/process/submitting-patches.rst およびその他の

Linux カーネルパッチ投稿に関する文書を踏まえ、それを補足するものです。



.. note:: 【訳註】

   可能な項目については、パッチもしくはパッチ内の更新を暗黙の主語として、

   その望ましい状態を表す文体とします。その他、原義を損なわない範囲で

   係り結びを調整するなど、簡潔で把握しやすい箇条書きを目指します。





コードのレビュー

================



1) 利用する機能について、その機能を定義・宣言しているファイルを

   ``#include`` している。

   他のヘッダーファイル経由での取り込みに依存しない。



2) Documentation/process/coding-style.rst に詳述されている一般的なスタイル

   についてチェック済み。



3) メモリバリアー (例, ``barrier()``, ``rmb()``, ``wmb()``) について、

   そのすべてに、作用と目的、及び必要理由についての説明がソースコード内の

   コメントとして記述されている。





Kconfig 変更のレビュー

======================



1) 新規の、もしくは変更された ``CONFIG`` オプションについて、それが関係する

   コンフィグメニューへの悪影響がない。また、

   Documentation/kbuild/kconfig-language.rst の

   "Menu attibutes: default value" に記載の例外条件を満たす場合を除き、

   そのデフォルトが無効になっている。



2) 新規の ``Kconfig`` オプションにヘルプテキストがある。



3) 妥当な ``Kconfig`` の組み合わせについて注意深くレビューされている。

   これをテストでやり切るのは困難で、知力が決め手となる。



ドキュメンテーションの作成

==========================



1) グローバルなカーネル API が  :ref:`kernel-doc <kernel_doc>` の形式で

   ドキュメント化されている (静的関数には求められないが、付けてもよい)。



2) 新規 ``/proc`` エントリーが、すべて ``Documentation/`` 以下に記載されて

   いる。



3) 新規カーネル・ブート・パラメータが、すべて

   ``Documentation/admin-guide/kernel-parameters.rst`` に記載されている。



4) 新規モジュール・パラメータが、すべて ``MODULE_PARM_DESC()`` によって記述

   されている。



5) 新規ユーザースペース・インターフェースが、すべて ``Documentaion/ABI/``

   以下に記載されている。詳しくは、 ``Documentation/ABI/README`` を参照。

   ユーザースペース・インターフェースを変更するパッチは、

   linux-api@vger.kernel.org にも CC すべし。



6) なんらかの ioctl を追加するパッチは、

   ``Documentation/userspace-api/ioctl/ioctl-number.rst``

   の更新を伴う。



ツールによるコードのチェック

============================



1) スタイル・チェッカー (``scripts/checkpatch.pl``) によって、犯しがちな

   パッチ・スタイルの違反がないことを確認済み。

   指摘される違反を残す場合は、それを正当化できること。



2) sparse により入念にチェック済み。



3) ``make checkstack`` で指摘される問題があれば、それが修正済み。

   ``checkstack`` は問題点を明示的には指摘しないが、 スタック消費が

   512 バイトを越える関数は見直しの候補。



コードのビルド

==============



1) 以下の条件でクリーンにビルドできる。



   a) 適用可能な、および ``=y``, ``=m``, ``=n`` を変更した ``CONFIG``

      オプションでのビルド。

      ``gcc`` およびリンカーからの警告・エラーがないこと。



   b) ``allnoconfig`` と ``allmodconfig`` がパス



   c) ``O=builddir`` を指定してのビルド



   d) Documentation/ 以下の変更に関して、ドキュメントのビルドで新たな警告や

      エラーが出ない。

      ``make htmldocs`` または ``make pdfdocs`` でビルドし、問題があれば修正。



2) ローカルのクロス・コンパイル・ツール、その他のビルド環境 (訳註: build farm)

   を使って、複数の CPU アーキテクチャ向けにビルドできる。

   特に、ワードサイズ (32 ビットと 64 ビット) やエンディアン (ビッグとリトル)

   の異なるアーキテクチャを対象とするテストは、表現可能数値範囲・データ整列・

   エンディアンなどについての誤った仮定に起因する様々な移植上の問題を捕える

   のに効果的。



3) 新規に追加されたコードについて (``make KCFLAGS=-W`` を使って)

   ``gcc -W`` でコンパイル。

   これは多くのノイズを伴うが、

   ``warning: comparison between signed and unsigned``

   の類いのバグをあぶり出すのに効果的。



4) 変更されるソースコードが、下記の ``Kconfig`` シンボルに関連するカーネル

   API や機能に依存 (もしくは利用) する場合、それらの ``Kconfig`` シンボルが、

   無効、および (可能なら) ``=m`` の場合を組み合わせた複数のビルドを

   (全部まとめてではなく、いろいろなランダムの組み合わせで) テスト済み。



   ``CONFIG_SMP``, ``CONFIG_SYSFS``, ``CONFIG_PROC_FS``, ``CONFIG_INPUT``,

   ``CONFIG_PCI``, ``CONFIG_BLOCK``, ``CONFIG_PM``, ``CONFIG_MAGIC_SYSRQ``,

   ``CONFIG_NET``, ``CONFIG_INET=n`` (ただし、後者は ``CONFIG_NET=y``

   との組み合わせ)。



コードのテスト

==============



1) ``CONFIG_PREEMPT``, ``CONFIG_DEBUG_PREEMPT``,

   ``CONFIG_SLUB_DEBUG``, ``CONFIG_DEBUG_PAGEALLOC``, ``CONFIG_DEBUG_MUTEXES``,

   ``CONFIG_DEBUG_SPINLOCK``, ``CONFIG_DEBUG_ATOMIC_SLEEP``,

   ``CONFIG_PROVE_RCU`` および ``CONFIG_DEBUG_OBJECTS_RCU_HEAD`` をすべて

   同時に有効にしてのテスト済み。



2) ``CONFIG_SMP`` と ``CONFIG_PREEMPT`` が有効と無効の場合について、ビルドと

   ランタイムのテスト済み。



3) lockdep の機能をすべて有効にしての実行で、すべてのコード経路が確認済み。



4) 最低限、slab と ページ・アロケーションの失敗に関する誤り注入

   (訳註: fault injection) によるチェック済み。

   詳しくは、 Documentation/fault-injection/index.rst を参照。

   新規のコードが多い場合は、サブシステム対象の誤り注入を追加するのが望ましい

   可能性あり。



5) linux-next の最新タグに対するテストにより、他でキューイングされている

   パッチや、VM、VFS、その他のサブシステム内のすべての変更と組み合わせての

   動作を確認済み。