| /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.
50 (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/ |
| 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 …]
|
| H A D | Makefile | 2 # Makefile for Sphinx documentation
8 # Check for broken documentation file references
10 $(shell $(srctree)/scripts/documentation-file-ref-check --warn)
15 $(shell $(srctree)/scripts/get_abi.py --dir $(srctree)/Documentation/ABI validate)
24 _SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Docu…
83 # e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media
88 …cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2…
92 $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \
105 YNL_INDEX:=$(srctree)/Documentation/networking/netlink_spec/index.rst
106 YNL_RST_DIR:=$(srctree)/Documentation/networking/netlink_spec
[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/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
|
| H A D | testing.rst | 18 These are the tests that come from the examples in the Rust documentation. They
30 Documentation/dev-tools/kunit/index.rst for the general KUnit documentation
31 and Documentation/dev-tools/kunit/architecture.rst for the details of kernel
43 KUnit tests are documentation tests
46 These documentation tests are typically examples of usage of any item (e.g.
50 documentation. For instance:
119 documentation do not need to care about which testing framework is used. In
126 Since these tests are examples, i.e. they are part of the documentation, they
136 Additionally, there are the ``#[test]`` tests. Like for documentation tests,
143 For instance, assume we want to test the function ``f`` from the documentation
[all …]
|
| /linux/Documentation/translations/zh_TW/process/ |
| 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 | 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/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/scripts/ |
| H A D | kernel-doc | 85 Print formatted kernel documentation to stdout
88 documentation comments, and print formatted documentation
91 The documentation comments are identified by the "/**"
94 See Documentation/doc-guide/kernel-doc.rst for the
95 documentation comment syntax.
114 Read C language source or header FILEs, extract embedded documentation comments,
115 and print formatted documentation to standard output.
117 The documentation comments are identified by the "/**" opening comment mark.
119 See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
129 Only output documentation for the symbols that have been
[all …]
|
| H A D | kernel-doc.py | 85 Print formatted kernel documentation to stdout
88 documentation comments, and print formatted documentation
91 The documentation comments are identified by the "/**"
94 See Documentation/doc-guide/kernel-doc.rst for the
95 documentation comment syntax.
114 Read C language source or header FILEs, extract embedded documentation comments,
115 and print formatted documentation to standard output.
117 The documentation comments are identified by the "/**" opening comment mark.
119 See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
129 Only output documentation for the symbols that have been
[all …]
|
| /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/drivers/firewire/ |
| H A D | Kconfig | 35 to the KUnit documentation in Documentation/dev-tools/kunit/.
51 to the KUnit documentation in Documentation/dev-tools/kunit/.
67 to the KUnit documentation in Documentation/dev-tools/kunit/.
82 to the KUnit documentation in Documentation/dev-tools/kunit/.
109 to the KUnit documentation in Documentation/dev-tools/kunit/.
|
| /linux/Documentation/dev-tools/kunit/api/ |
| H A D | index.rst | 23 Documentation/dev-tools/kunit/api/test.rst
27 Documentation/dev-tools/kunit/api/resource.rst
31 Documentation/dev-tools/kunit/api/functionredirection.rst
38 Documentation/dev-tools/kunit/api/clk.rst
42 Documentation/dev-tools/kunit/api/of.rst
46 Documentation/dev-tools/kunit/api/platformdevice.rst
|
| /linux/drivers/iio/test/ |
| H A D | Kconfig | 17 to the KUnit documentation in Documentation/dev-tools/kunit/.
29 to the KUnit documentation in Documentation/dev-tools/kunit/.
41 to the KUnit documentation in Documentation/dev-tools/kunit/.
|
| /linux/Documentation/translations/zh_CN/admin-guide/ |
| H A D | README.rst | 3 :Original: Documentation/admin-guide/README.rst
55 :ref:`Documentation/process/changes.rst <changes>` 文件，它包含了升级内核
86 :ref:`Documentation/process/applying-patches.rst <applying_patches>` 。
107 :ref:`Documentation/process/changes.rst <changes>`
208 Documentation/kbuild/kconfig.rst。
228 有关更多信息，请参阅 :ref:`Documentation/process/changes.rst <changes>` 。
284 Documentation/translations/zh_CN/admin-guide/reporting-issues.rst 。
287 Documentation/translations/zh_CN/admin-guide/bug-hunting.rst 。
290 Documentation/translations/zh_CN/dev-tools/gdb-kernel-debugging.rst
291 和 Documentation/dev-tools/kgdb.rst 。
|
| /linux/Documentation/driver-api/dmaengine/ |
| H A D | index.rst | 2 DMAEngine documentation
5 DMAEngine documentation provides documents for various aspects of DMAEngine
8 DMAEngine development documentation
19 DMAEngine client documentation
30 DMA Test documentation
40 PXA DMA documentation
|