| /linux/Documentation/doc-guide/ |
| H A D | contributing.rst | 3 How to help improve kernel documentation
6 Documentation is an important part of any software-development project.
7 Good documentation helps to bring new developers in and helps established
8 developers work more effectively. Without top-quality documentation, a lot
12 Unfortunately, the kernel's documentation currently falls far short of what
16 Kernel documentation improvements can be made by developers at a variety of
19 documentation maintainer's list of tasks that most urgently need to be
22 The documentation TODO list
26 documentation to where it should be. This list contains a number of
28 improve the documentation, please do not hold back!
[all …]
|
| H A D | sphinx.rst | 4 Using Sphinx for kernel documentation
7 The Linux kernel uses `Sphinx`_ to generate pretty documentation from
8 `reStructuredText`_ files under ``Documentation``. To build the documentation in
10 documentation is placed in ``Documentation/output``.
16 documentation comments, or kernel-doc comments, from source files. Usually these
21 Finally, there are thousands of plain text documentation files scattered around
22 ``Documentation``. Some of these will likely be converted to reStructuredText
30 The ReST markups currently used by the Documentation/ files are meant to be
38 on your machine would cause the documentation build to break.
56 (sphinx_latest) $ pip install -r Documentation/sphinx/requirements.txt
[all …]
|
| H A D | maintainer-profile.rst | 3 Documentation subsystem maintainer entry profile
6 The documentation "subsystem" is the central coordinating point for the
7 kernel's documentation and associated infrastructure. It covers the
8 hierarchy under Documentation/ (with the exception of
9 Documentation/devicetree), various utilities under scripts/ and, at least
14 of portions of Documentation/, and many more freely apply changes there
15 when it is convenient. Beyond that, much of the kernel's documentation is
19 The mailing list for documentation is linux-doc@vger.kernel.org. Patches
25 When making documentation changes, you should actually build the
26 documentation and ensure that no new errors or warnings have been
[all …]
|
| /linux/drivers/gpu/drm/msm/registers/ |
| H A D | rules-fd.xsd | 8 <documentation>
15 </documentation>
16 <documentation>Version 0.1</documentation>
40 <!-- Documentation elements -->
58 <documentation>
60 </documentation>
71 <documentation>nickType</documentation>
80 <documentation>databaseType</documentation>
90 <documentation>importType</documentation>
97 <documentation>copyrightType</documentation>
[all …]
|
| /linux/Documentation/translations/zh_CN/dev-tools/ |
| H A D | testing-overview.rst | 5 :Original: Documentation/dev-tools/testing-overview.rst
31 （Documentation/dev-tools/testing-overview.rst）辅助阅读。
34 KUnit（Documentation/dev-tools/kunit/index.rst）是用于“白箱”测
48 Documentation/dev-tools/kunit/style.rst
50 kselftest（Documentation/dev-tools/kselftest.rst），相对来说，大量用
73 Documentation/translations/zh_CN/dev-tools/gcov.rst 是GCC的覆盖率测试
78 Documentation/dev-tools/kcov.rst 是能够构建在内核之中，用于在每个任务
92 Documentation/dev-tools/kmemleak.rst
94 Documentation/dev-tools/kasan.rst
96 Documentation/dev-tools/ubsan.rst
[all …]
|
| /linux/ |
| H A D | MAINTAINERS | 29 or a URI. See Documentation/maintainer/maintainer-entry-profile.rst
74 F: Documentation/networking/device_drivers/ethernet/3com/vortex.rst
101 F: Documentation/networking/6lowpan.rst
119 F: Documentation/driver-api/80211/cfg80211.rst
120 F: Documentation/networking/regulatory.rst
162 F: Documentation/filesystems/9p.rst
186 F: Documentation/scsi/aacraid.rst
199 F: Documentation/devicetree/bindings/power/supply/*ab8500*
291 F: Documentation/ABI/testing/configfs-acpi
292 F: Documentation/ABI/testing/sysfs-bus-acpi
[all …]
|
| /linux/Documentation/translations/zh_TW/dev-tools/ |
| H A D | testing-overview.rst | 5 :Original: Documentation/dev-tools/testing-overview.rst
31 （Documentation/dev-tools/testing-overview.rst）輔助閱讀。
34 KUnit（Documentation/dev-tools/kunit/index.rst）是用於“白箱”測
48 Documentation/dev-tools/kunit/style.rst
50 kselftest（Documentation/dev-tools/kselftest.rst），相對來說，大量用
73 Documentation/translations/zh_CN/dev-tools/gcov.rst 是GCC的覆蓋率測試
78 Documentation/dev-tools/kcov.rst 是能夠構建在內核之中，用於在每個任務
92 Documentation/dev-tools/kmemleak.rst
94 Documentation/dev-tools/kasan.rst
96 Documentation/dev-tools/ubsan.rst
[all …]
|
| /linux/Documentation/translations/zh_TW/process/ |
| H A D | submit-checklist.rst | 5 :Original: Documentation/process/submit-checklist.rst
19 這些都是在 Documentation/translations/zh_CN/process/submitting-patches.rst
34 d) 任何 Documentation/ 下的變更都能成功構建且不引入新警告/錯誤。
42 5) 按 Documentation/translations/zh_CN/process/coding-style.rst 所述檢查您的
48 它們符合 ``Documentation/kbuild/kconfig-language.rst`` 菜單屬性：默認值中
57 （參見 Documentation/translations/zh_CN/dev-tools/sparse.rst ）
80 15) 所有新的 ``/proc`` 條目都記錄在 ``Documentation/``
83 Documentation/admin-guide/kernel-parameters.rst 中。
87 18) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息，
88 請參閱 ``Documentation/ABI/README`` 。更改用戶空間接口的補丁應該抄送
[all …]
|
| H A D | howto.rst | 7 :Original: :ref:`Documentation/process/howto.rst <process_howto>`
70 :ref:`Documentation/translations/zh_TW/process/license-rules.rst <tw_kernel_licensing>`
88 :ref:`Documentation/admin-guide/README.rst <readme>`
93 :ref:`Documentation/process/changes.rst <changes>`
96 :ref:`Documentation/translations/zh_TW/process/coding-style.rst <tw_codingstyle>`
101 :ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>`
120 :ref:`Documentation/translations/zh_TW/process/stable-api-nonsense.rst <tw_stable_api_nonsense>`
131 :ref:`Documentation/process/security-bugs.rst <securitybugs>`
135 :ref:`Documentation/translations/zh_TW/process/management-style.rst <tw_managementstyle>`
141 :ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>`
[all …]
|
| /linux/Documentation/translations/zh_CN/process/ |
| H A D | submit-checklist.rst | 3 :Original: Documentation/process/submit-checklist.rst
16 这些都是在 Documentation/translations/zh_CN/process/submitting-patches.rst
39 5) 按 Documentation/translations/zh_CN/process/coding-style.rst 所述检查您的
45 它们符合 ``Documentation/kbuild/kconfig-language.rst`` 菜单属性：默认值中
54 （参见 Documentation/translations/zh_CN/dev-tools/sparse.rst ）
77 15) 所有新的 ``/proc`` 条目都记录在 ``Documentation/``
80 Documentation/admin-guide/kernel-parameters.rst 中。
84 18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息，
85 请参阅 ``Documentation/ABI/README`` 。更改用户空间接口的补丁应该抄送
88 19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。
[all …]
|
| H A D | howto.rst | 5 :Original: :ref:`Documentation/process/howto.rst <process_howto>`
67 :ref:`Documentation/translations/zh_CN/process/license-rules.rst <cn_kernel_licensing>`
85 :ref:`Documentation/admin-guide/README.rst <readme>`
90 :ref:`Documentation/process/changes.rst <changes>`
93 :ref:`Documentation/translations/zh_CN/process/coding-style.rst <cn_codingstyle>`
98 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
117 :ref:`Documentation/translations/zh_CN/process/stable-api-nonsense.rst <cn_stable_api_nonsense>`
128 :ref:`Documentation/process/security-bugs.rst <securitybugs>`
132 :ref:`Documentation/translations/zh_CN/process/management-style.rst <cn_managementstyle>`
138 :ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>`
[all …]
|
| /linux/scripts/ |
| H A D | documentation-file-ref-check | 4 # Treewide grep for references to files under Documentation, and report
12 # to mention a past documentation file, for example, to give credits for
15 "Documentation/scsi/scsi_mid_low_api.rst" => "Documentation/Configure.help",
16 "drivers/vhost/vhost.c" => "Documentation/virtual/lguest/lguest.c",
50 open IN, "git grep ':doc:\`' Documentation/|"
67 $f =~ s,^/,Documentation/,;
83 open IN, "git grep 'Documentation/'|"
103 # Ignore the dir where documentation will be built
104 next if ($ln =~ m,\b(\S*)Documentation/output,);
106 if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*)(.*),) {
[all …]
|
| /linux/Documentation/ |
| H A D | index.rst | 6 The Linux Kernel documentation
9 This is the top level of the kernel's documentation tree. Kernel
10 documentation, like the kernel itself, is very much a work in progress;
13 documentation are welcome; join the linux-doc list at vger.kernel.org if
55 Writing documentation <doc-guide/index>
65 User-oriented documentation
82 which are kept separately from the kernel's own documentation.
84 Firmware-related documentation
96 Architecture-specific documentation
105 Other documentation
[all …]
|
| /linux/Documentation/devicetree/bindings/mmc/ |
| H A D | sdhci-st.txt | 4 Documentation/devicetree/bindings/mmc/mmc.txt and the properties
14 See: Documentation/devicetree/bindings/resource-names.txt
16 See: Documentation/devicetree/bindings/clock/clock-bindings.txt
23 See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
36 See: Documentation/devicetree/bindings/mmc/mmc.txt.
39 See: Documentation/devicetree/bindings/mmc/mmc.txt.
43 See: Documentation/devicetree/bindings/mmc/mmc.txt.
46 See: Documentation/devicetree/bindings/reset/reset.txt
52 See: Documentation/devicetree/bindings/mmc/mmc.txt.
55 See: Documentation/devicetree/bindings/mmc/mmc.txt.
[all …]
|
| /linux/Documentation/process/ |
| H A D | submit-checklist.rst | 10 These are all above and beyond the documentation that is provided in
11 :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
22 :ref:`Documentation/process/coding-style.rst <codingstyle>`.
33 ``Documentation/kbuild/kconfig-language.rst`` Menu attributes: default value.
41 Provide documentation
47 2) All new ``/proc`` entries are documented under ``Documentation/``
50 ``Documentation/admin-guide/kernel-parameters.rst``.
54 5) All new userspace interfaces are documented in ``Documentation/ABI/``.
55 See ``Documentation/ABI/README`` for more information.
60 ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
[all …]
|
| /linux/drivers/cpufreq/ |
| H A D | Kconfig.x86 | 30 <file:Documentation/admin-guide/pm/cpufreq_drivers.rst>.
50 <file:Documentation/admin-guide/pm/amd-pstate.rst>.
69 <file:Documentation/admin-guide/pm/amd-pstate.rst>.
99 For details, take a look at <file:Documentation/cpu-freq/>.
126 For details, take a look at <file:Documentation/cpu-freq/>.
136 For details, take a look at <file:Documentation/cpu-freq/>.
148 For details, take a look at <file:Documentation/cpu-freq/>.
158 For details, take a look at <file:Documentation/cpu-freq/>.
179 For details, take a look at <file:Documentation/cpu-freq/>.
205 For details, take a look at <file:Documentation/cpu-freq/>.
[all …]
|
| /linux/Documentation/dev-tools/ |
| H A D | testing-overview.rst | 28 KUnit (Documentation/dev-tools/kunit/index.rst) is an entirely in-kernel system
44 Documentation/dev-tools/kunit/style.rst
47 kselftest (Documentation/dev-tools/kselftest.rst), on the other hand, is
74 Documentation/dev-tools/gcov.rst is GCC's coverage testing tool, which can be
79 Documentation/dev-tools/kcov.rst is a feature which can be built in to the
97 Documentation/dev-tools/kmemleak.rst
99 use-after-free errors. See Documentation/dev-tools/kasan.rst
101 overflows. See Documentation/dev-tools/ubsan.rst
102 * KCSAN detects data races. See Documentation/dev-tools/kcsan.rst
104 KASAN and can be used in production. See Documentation/dev-tools/kfence.rst
[all …]
|
| /linux/Documentation/rust/ |
| H A D | index.rst | 6 Documentation related to Rust within the kernel. To start using Rust
28 Code documentation
31 Given a kernel configuration, the kernel may generate Rust code documentation,
36 This kernel documentation was built with `Rust code documentation
41 This kernel documentation was not built with Rust code documentation.
47 Please see the :ref:`Code documentation <rust_code_documentation>` section for
|
| /linux/scripts/kconfig/tests/err_recursive_dep/ |
| H A D | expected_stderr | 3 For a resolution refer to Documentation/kbuild/kconfig-language.rst
8 For a resolution refer to Documentation/kbuild/kconfig-language.rst
14 For a resolution refer to Documentation/kbuild/kconfig-language.rst
20 For a resolution refer to Documentation/kbuild/kconfig-language.rst
26 For a resolution refer to Documentation/kbuild/kconfig-language.rst
32 For a resolution refer to Documentation/kbuild/kconfig-language.rst
37 For a resolution refer to Documentation/kbuild/kconfig-language.rst
|
| /linux/Documentation/devicetree/bindings/mfd/ |
| H A D | motorola-cpcap.txt | 19 - Documentation/devicetree/bindings/power/supply/cpcap-battery.yaml
20 - Documentation/devicetree/bindings/power/supply/cpcap-charger.yaml
21 - Documentation/devicetree/bindings/regulator/cpcap-regulator.txt
22 - Documentation/devicetree/bindings/phy/phy-cpcap-usb.txt
23 - Documentation/devicetree/bindings/input/cpcap-pwrbutton.txt
24 - Documentation/devicetree/bindings/rtc/cpcap-rtc.txt
25 - Documentation/devicetree/bindings/leds/leds-cpcap.txt
26 - Documentation/devicetree/bindings/iio/adc/motorola,cpcap-adc.yaml
|
| /linux/Documentation/devicetree/bindings/ |
| H A D | submitting-patches.rst | 11 Documentation/process/submitting-patches.rst applies.
13 1) The Documentation/ and include/dt-bindings/ portion of the patch should
24 use "Documentation" or "doc" because that is implied. All bindings are
33 See Documentation/devicetree/bindings/writing-schema.rst for more details
46 5) The Documentation/ portion of the patch should come in the series before
51 in Documentation/devicetree/bindings. This rule applies even if
55 ("checkpatch: add DT compatible string documentation checks"). ]
58 driver, the documentation should also include a compatible
85 0) Please see Documentation/devicetree/bindings/ABI.rst for details
|
| /linux/Documentation/scsi/ |
| H A D | scsi-parameters.rst | 7 See Documentation/admin-guide/kernel-parameters.rst for general information on
23 See Documentation/scsi/aha152x.rst.
29 See Documentation/scsi/aic7xxx.rst.
32 See Documentation/scsi/aic79xx.rst.
61 See Documentation/scsi/g_NCR5380.rst.
64 See Documentation/scsi/g_NCR5380.rst.
67 See Documentation/scsi/g_NCR5380.rst.
73 See also Documentation/scsi/st.rst.
105 See Documentation/scsi/st.rst.
|
| /linux/Documentation/translations/zh_CN/doc-guide/ |
| H A D | sphinx.rst | 3 :Original: Documentation/doc-guide/sphinx.rst
12 Linux内核使用 `Sphinx <http://www.sphinx-doc.org/>`_ 来把 ``Documentation``
15 或PDF格式的文档。生成的文档放在 ``Documentation/output`` 文件夹中。
21 最后，有成千上万的纯文本文档文件散布在 ``Documentation`` 里。随着时间推移，
29 Documentation/ 下的ReST文件现在使用sphinx1.7或更高版本构建。
53 (sphinx_2.4.4) $ pip install -r Documentation/sphinx/requirements.txt
95 pip install -r Documentation/sphinx/requirements.txt
117 的格式：请参阅 ``make help`` 的文档部分。生成的文档放在 ``Documentation/output``
136 1. 在 ``Documentation`` 下某处添加一个新的 ``.rst`` 文件。
137 2. 从 ``Documentation/index.rst`` 中的Sphinx `主目录树`_ 链接到它。
[all …]
|
| /linux/Documentation/devicetree/bindings/power/ |
| H A D | wakeup-source.txt | 24 1. "gpio-key,wakeup" Documentation/devicetree/bindings/input/gpio-keys{,-polled}.txt
25 2. "has-tpo" Documentation/devicetree/bindings/rtc/rtc-opal.txt
26 3. "linux,wakeup" Documentation/devicetree/bindings/input/gpio-matrix-keypad.txt
27 Documentation/devicetree/bindings/mfd/tc3589x.txt
28 Documentation/devicetree/bindings/input/touchscreen/ti,ads7843.yaml
29 4. "linux,keypad-wakeup" Documentation/devicetree/bindings/input/qcom,pm8921-keypad.yaml
30 5. "linux,input-wakeup" Documentation/devicetree/bindings/input/samsung,s3c6410-keypad.yaml
31 6. "nvidia,wakeup-source" Documentation/devicetree/bindings/input/nvidia,tegra20-kbc.txt
|
| /linux/Documentation/translations/sp_SP/process/ |
| H A D | submit-checklist.rst | 3 :Original: Documentation/process/submit-checklist.rst
16 :ref:`Documentation/translations/sp_SP/process/submitting-patches.rst <sp_submittingpatches>`
45 :ref:`Documentation/translations/sp_SP/process/coding-style.rst <sp_codingstyle>`.
54 ``Documentation/kbuild/kconfig-language.rst`` Atributos del menú: valor por defecto.
91 ``Documentation/``.
94 en ``Documentation/admin-guide/kernel-parameters.rst``.
100 en ``Documentation/ABI/``. Consulte ``Documentation/ABI/README`` para
105 de slab y página. Consulte ``Documentation/fault-injection/``.
123 ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
|