Searched full:documentation (Results 1 – 25 of 6024) sorted by relevance
12345678910>>...241
| /Linux-v5.15/Documentation/doc-guide/ |
| 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 …]
|
| D | sphinx.rst | 6 The Linux kernel uses `Sphinx`_ to generate pretty documentation from
7 `reStructuredText`_ files under ``Documentation``. To build the documentation in
9 documentation is placed in ``Documentation/output``.
15 documentation comments, or kernel-doc comments, from source files. Usually these
20 Finally, there are thousands of plain text documentation files scattered around
21 ``Documentation``. Some of these will likely be converted to reStructuredText
29 The ReST markups currently used by the Documentation/ files are meant to be
37 on your machine would cause the documentation build to break.
62 (sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt
67 the virtual environment before building the documentation.
[all …]
|
| 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 …]
|
| D | kernel-doc.rst | 4 The Linux kernel source files may contain structured documentation
6 and design of the code. It is easier to keep documentation up-to-date
26 It is good practice to also provide kernel-doc formatted documentation
29 documentation for private (file ``static``) routines, for consistency of
43 that somebody changing the code will also change the documentation. The
49 documentation comments. For example::
53 The documentation format is verified by the kernel build when it is
58 Function documentation
168 Structure, union, and enumeration documentation
200 area are not listed in the generated output documentation.
[all …]
|
| /Linux-v5.15/Documentation/translations/zh_CN/dev-tools/ |
| 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-v5.15/Documentation/ |
| D | index.rst | 4 .. The Linux Kernel documentation master file, created by
11 The Linux Kernel documentation
14 This is the top level of the kernel's documentation tree. Kernel
15 documentation, like the kernel itself, is very much a work in progress;
18 documentation are welcome; join the linux-doc list at vger.kernel.org if
21 Licensing documentation
30 User-oriented documentation
42 Firmware-related documentation
53 Application-developer documentation
87 Kernel API documentation
[all …]
|
| 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.pl validate --dir $(srctree)/Documentation/ABI)
22 _SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Docu…
72 # e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media
75 …cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2…
79 $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \
132 $(Q)cd $(srctree);scripts/documentation-file-ref-check
136 $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean
[all …]
|
| /Linux-v5.15/ |
| D | MAINTAINERS | 40 See Documentation/process/coding-style.rst for guidance here.
46 See Documentation/process/submitting-patches.rst for details.
59 Documentation/process/submitting-patches.rst.
76 Documentation/admin-guide/security-bugs.rst for details.
105 or a URI. See Documentation/maintainer/maintainer-entry-profile.rst
150 F: Documentation/networking/device_drivers/ethernet/3com/vortex.rst
178 F: Documentation/networking/6lowpan.rst
195 F: Documentation/driver-api/80211/cfg80211.rst
196 F: Documentation/networking/regulatory.rst
235 F: Documentation/filesystems/9p.rst
[all …]
|
| /Linux-v5.15/scripts/ |
| 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/'|"
100 # Ignore the dir where documentation will be built
101 next if ($ln =~ m,\b(\S*)Documentation/output,);
103 if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*)(.*),) {
[all …]
|
| /Linux-v5.15/Documentation/translations/zh_CN/process/ |
| D | submit-checklist.rst | 3 :Original: :ref:`Documentation/process/submit-checklist.rst <submitchecklist>`
15 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
35 5) 如下所述 :ref:`Documentation/translations/zh_CN/process/coding-style.rst <cn_codingstyle>`.
41 它们符合 ``Documentation/kbuild/kconfig-language.rst`` 中记录的异常条件,
74 16) 所有新的/proc条目都记录在 ``Documentation/``
77 Documentation/admin-guide/kernel-parameters.rst 中。
81 19) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息，
82 请参阅 ``Documentation/ABI/README`` 。更改用户空间接口的补丁应该抄送
85 20) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/``
98 24) 如果补丁添加了任何ioctl，那么也要更新 ``Documentation/userspace-api/ioctl/ioctl-number.rst``
|
| 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>`
99 :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>`
118 :ref:`Documentation/translations/zh_CN/process/stable-api-nonsense.rst <cn_stable_api_nonsense>`
129 :ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>`
133 :ref:`Documentation/translations/zh_CN/process/management-style.rst <cn_managementstyle>`
[all …]
|
| D | 5.Posting.rst | 3 :Original: :ref:`Documentation/process/5.Posting.rst <development_posting>`
22 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`，
23 :ref:`Documentation/translations/zh_CN/process/submitting-drivers.rst <cn_submittingdrivers>`
24 和 :ref:`Documentation/translations/zh_CN/process/submit-checklist.rst <cn_submitchecklist>`。
155 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
166 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
173 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
181 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
198 :ref:`Documentation/translations/zh_CN/process/email-clients.rst <cn_email_clients>`
|
| /Linux-v5.15/Documentation/translations/zh_TW/process/ |
| D | submit-checklist.rst | 5 :Original: :ref:`Documentation/process/submit-checklist.rst <submitchecklist>`
18 :ref:`Documentation/translations/zh_TW/process/submitting-patches.rst <tw_submittingpatches>`
38 5) 如下所述 :ref:`Documentation/translations/zh_TW/process/coding-style.rst <tw_codingstyle>`.
44 它們符合 ``Documentation/kbuild/kconfig-language.rst`` 中記錄的異常條件,
77 16) 所有新的/proc條目都記錄在 ``Documentation/``
80 Documentation/admin-guide/kernel-parameters.rst 中。
84 19) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息，
85 請參閱 ``Documentation/ABI/README`` 。更改用戶空間接口的補丁應該抄送
88 20) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/``
101 24) 如果補丁添加了任何ioctl，那麼也要更新 ``Documentation/userspace-api/ioctl/ioctl-number.rst``
|
| 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>`
102 :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>`
121 :ref:`Documentation/translations/zh_TW/process/stable-api-nonsense.rst <tw_stable_api_nonsense>`
132 :ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>`
136 :ref:`Documentation/translations/zh_TW/process/management-style.rst <tw_managementstyle>`
[all …]
|
| /Linux-v5.15/Documentation/devicetree/bindings/mmc/ |
| 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-v5.15/drivers/cpufreq/ |
| D | Kconfig.x86 | 30 <file:Documentation/admin-guide/pm/cpufreq_drivers.rst>.
49 For details, take a look at <file:Documentation/cpu-freq/>.
76 For details, take a look at <file:Documentation/cpu-freq/>.
86 For details, take a look at <file:Documentation/cpu-freq/>.
98 For details, take a look at <file:Documentation/cpu-freq/>.
108 For details, take a look at <file:Documentation/cpu-freq/>.
129 For details, take a look at <file:Documentation/cpu-freq/>.
155 For details, take a look at <file:Documentation/cpu-freq/>.
174 For details, take a look at <file:Documentation/cpu-freq/>.
197 For details, take a look at <file:Documentation/cpu-freq/>.
[all …]
|
| /Linux-v5.15/Documentation/process/ |
| D | submit-checklist.rst | 9 These are all above and beyond the documentation that is provided in
10 :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`
27 d) Any Documentation/ changes build successfully without new warnings/errors.
38 :ref:`Documentation/process/coding-style.rst <codingstyle>`.
46 ``Documentation/kbuild/kconfig-language.rst`` Menu attributes: default value.
80 15) All new ``/proc`` entries are documented under ``Documentation/``
83 ``Documentation/admin-guide/kernel-parameters.rst``.
87 18) All new userspace interfaces are documented in ``Documentation/ABI/``.
88 See ``Documentation/ABI/README`` for more information.
93 failures. See ``Documentation/fault-injection/``.
[all …]
|
| /Linux-v5.15/Documentation/devicetree/bindings/power/ |
| D | wakeup-source.txt | 20 1. "enable-sdio-wakeup" Documentation/devicetree/bindings/mmc/mmc.txt
21 2. "gpio-key,wakeup" Documentation/devicetree/bindings/input/gpio-keys{,-polled}.txt
22 3. "has-tpo" Documentation/devicetree/bindings/rtc/rtc-opal.txt
23 4. "linux,wakeup" Documentation/devicetree/bindings/input/gpio-matrix-keypad.txt
24 Documentation/devicetree/bindings/mfd/tc3589x.txt
25 Documentation/devicetree/bindings/input/touchscreen/ads7846.txt
26 5. "linux,keypad-wakeup" Documentation/devicetree/bindings/input/qcom,pm8xxx-keypad.txt
27 6. "linux,input-wakeup" Documentation/devicetree/bindings/input/samsung-keypad.txt
28 7. "nvidia,wakeup-source" Documentation/devicetree/bindings/input/nvidia,tegra20-kbc.txt
|
| /Linux-v5.15/scripts/kconfig/tests/err_recursive_dep/ |
| 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
31 For a resolution refer to Documentation/kbuild/kconfig-language.rst
37 For a resolution refer to Documentation/kbuild/kconfig-language.rst
|
| /Linux-v5.15/Documentation/devicetree/bindings/mfd/ |
| 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-v5.15/Documentation/translations/it_IT/process/ |
| D | submit-checklist.rst | 3 :Original: :ref:`Documentation/process/submit-checklist.rst <submitchecklist>`
16 :ref:`Documentation/translations/it_IT/process/submitting-patches.rst <it_submittingpatches>`.
31 d) Qualsiasi modifica in Documentation/ deve compilare con successo senza
42 scritte in :ref:`Documentation/translations/it_IT/process/coding-style.rst <it_codingstyle>`.
50 soddisfino i criteri descritti in ``Documentation/kbuild/kconfig-language.rst``
89 16) Tutti i nuovi elementi in ``/proc`` sono documentati in ``Documentation/``.
92 ``Documentation/admin-guide/kernel-parameters.rst``.
97 ``Documentation/ABI/``. Leggete ``Documentation/ABI/README`` per maggiori
102 nell'allocazione di pagine. Vedere ``Documentation/fault-injection/``.
121 ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
|
| /Linux-v5.15/Documentation/dev-tools/ |
| 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-v5.15/Documentation/scsi/ |
| 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-v5.15/Documentation/devicetree/bindings/ |
| D | submitting-patches.rst | 11 Documentation/process/submitting-patches.rst applies.
13 1) The Documentation/ and include/dt-bindings/ portion of the patch should
19 use "Documentation" or "doc" because that is implied. All bindings are
28 See Documentation/devicetree/bindings/writing-schema.rst for more details
41 5) The Documentation/ portion of the patch should come in the series before
46 in Documentation/devicetree/bindings. This rule applies even if
50 ("checkpatch: add DT compatible string documentation checks"). ]
62 driver, the documentation should also include a compatible
87 0) Please see Documentation/devicetree/bindings/ABI.rst for details
|
| /Linux-v5.15/Documentation/translations/zh_CN/doc-guide/ |
| 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.3或更高版本构建。
56 (sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt
98 pip install -r Documentation/sphinx/requirements.txt
120 的格式：请参阅 ``make help`` 的文档部分。生成的文档放在 ``Documentation/output``
139 1. 在 ``Documentation`` 下某处添加一个新的 ``.rst`` 文件。
140 2. 从 ``Documentation/index.rst`` 中的Sphinx `主目录树`_ 链接到它。
[all …]
|
12345678910>>...241
