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

Source file repositories/reference/linux-study-clean/Documentation/translations/ja_JP/process/submit-checklist.rst

File Facts

System
Linux kernel
Corpus path
Documentation/translations/ja_JP/process/submit-checklist.rst
Extension
.rst
Size
7894 bytes
Lines
164
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

.. 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 attributes: default value" に記載の例外条件を満たす場合を除き、
   そのデフォルトが無効になっている。

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

3) 妥当な ``Kconfig`` の組み合わせについて注意深くレビューされている。
   これをテストでやり切るのは困難で、知力が決め手となる。

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

1) グローバルなカーネル API が  :ref:`kernel-doc <kernel_doc>` の形式で
   ドキュメント化されている (静的関数には求められないが、付けてもよい)。

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

Annotation

Implementation Notes