Searched full:documentation (Results 1 – 25 of 4534) sorted by relevance
12345678910>>...182
| /Linux-v5.10/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.10/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 $(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.10/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.10/ |
| 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 …]
|
| D | README | 6 Documentation/admin-guide/README.rst first.
8 In order to build the documentation, use ``make htmldocs`` or
9 ``make pdfdocs``. The formatted documentation can also be read online at:
13 There are various text files in the Documentation/ subdirectory,
16 Please read the Documentation/process/changes.rst file, as it contains the
|
| /Linux-v5.10/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`` 。更改用户空间接口的补丁应该抄送
87 21) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/``
100 25) 如果补丁添加了任何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>`
15 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`,
16 :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>`
17 和 :ref:`Documentation/translations/zh_CN/process/submit-checklist.rst <cn_submitchecklist>`.
148 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
159 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
166 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
174 :ref:`Documentation/translations/zh_CN/process/submitting-patches.rst <cn_submittingpatches>`
191 :ref:`Documentation/translations/zh_CN/process/email-clients.rst <cn_email_clients>`
|
| /Linux-v5.10/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.10/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 17) All new ``/proc`` entries are documented under ``Documentation/``
83 ``Documentation/admin-guide/kernel-parameters.rst``.
87 20) All new userspace interfaces are documented in ``Documentation/ABI/``.
88 See ``Documentation/ABI/README`` for more information.
95 failures. See ``Documentation/fault-injection/``.
[all …]
|
| /Linux-v5.10/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.10/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.10/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/>.
86 For details, take a look at <file:Documentation/cpu-freq/>.
96 For details, take a look at <file:Documentation/cpu-freq/>.
108 For details, take a look at <file:Documentation/cpu-freq/>.
118 For details, take a look at <file:Documentation/cpu-freq/>.
139 For details, take a look at <file:Documentation/cpu-freq/>.
165 For details, take a look at <file:Documentation/cpu-freq/>.
184 For details, take a look at <file:Documentation/cpu-freq/>.
207 For details, take a look at <file:Documentation/cpu-freq/>.
[all …]
|
| /Linux-v5.10/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.
64 See Documentation/scsi/g_NCR5380.rst.
67 See Documentation/scsi/g_NCR5380.rst.
70 See Documentation/scsi/g_NCR5380.rst.
76 See also Documentation/scsi/st.rst.
108 See Documentation/scsi/st.rst.
|
| /Linux-v5.10/Documentation/devicetree/bindings/sound/ |
| D | adi,adau1977.txt | 4 https://www.analog.com/media/en/technical-documentation/data-sheets/ADAU1977.pdf
5 https://www.analog.com/media/en/technical-documentation/data-sheets/ADAU1978.pdf
6 https://www.analog.com/media/en/technical-documentation/data-sheets/ADAU1979.pdf
17 Documentation/devicetree/bindings/regulator/regulator.txt
21 Documentation/devicetree/bindings/gpio/gpio.txt
24 Documentation/devicetree/bindings/regulator/regulator.txt
33 Documentation/devicetree/bindings/spi/spi-bus.txt
|
| /Linux-v5.10/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>`.
38 scritte in :ref:`Documentation/translations/it_IT/process/coding-style.rst <it_codingstyle>`.
46 soddisfino i criteri descritti in ``Documentation/kbuild/kconfig-language.rst``
86 16) Tutti i nuovi elementi in ``/proc`` sono documentati in ``Documentation/``.
89 ``Documentation/admin-guide/kernel-parameters.rst``.
94 ``Documentation/ABI/``. Leggete ``Documentation/ABI/README`` per maggiori
101 nell'allocazione di pagine. Vedere ``Documentation/fault-injection/``.
120 ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
|
| /Linux-v5.10/Documentation/driver-api/dmaengine/ |
| 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
|
| /Linux-v5.10/tools/memory-model/ |
| D | README | 66 explore the state space of small litmus tests. Documentation describing
68 tests is available in tools/memory-model/Documentation/litmus-tests.txt.
73 Documentation/litmus-tests/
81 Documentation describing litmus tests and now to use them may be found
84 tools/memory-model/Documentation/litmus-tests.txt
113 tool itself, but please be aware that this documentation is intended for
153 for more information. And again, please be aware that this documentation
164 Documentation/cheatsheet.txt
167 Documentation/explanation.txt
170 Documentation/litmus-tests.txt
[all …]
|
| /Linux-v5.10/Documentation/translations/ja_JP/ |
| D | SubmitChecklist | 2 This is a version of Documentation/process/submit-checklist.rst into Japanese.
17 linux-2.6.26/Documentation/process/submit-checklist.rst の和訳です。
30 をいくつか紹介します。ここにある全ての事柄は、Documentation/process/submitting-patches.rst
79 15: /proc に新しいエントリを追加した場合には、Documentation/ 配下に
88 18: 新しいuserspaceインタフェースを作成した場合には、Documentation/ABI/ に
89 Documentation/ABI/README を参考にして必ずドキュメントを追加してください。
95 Documentation/fault-injection/ を参照してください。
|
| /Linux-v5.10/Documentation/devicetree/bindings/leds/ |
| D | leds-aat1290.txt | 23 node - see Documentation/devicetree/bindings/leds/common.txt.
26 - led-max-microamp : see Documentation/devicetree/bindings/leds/common.txt
27 - flash-max-microamp : see Documentation/devicetree/bindings/leds/common.txt
30 - flash-max-timeout-us : see Documentation/devicetree/bindings/leds/common.txt
35 - function : see Documentation/devicetree/bindings/leds/common.txt
36 - color : see Documentation/devicetree/bindings/leds/common.txt
37 - label : see Documentation/devicetree/bindings/leds/common.txt (deprecated)
|
| /Linux-v5.10/Documentation/translations/ |
| D | index.rst | 24 documentation in their native language, but please bear in mind that the
25 *only* official documentation is the English one: :ref:`linux_doc`.
29 contributors - follow the evolution of the official documentation and they
34 documentation.
36 A translation is not a fork of the official documentation, therefore
38 English documentation. Any content addition, removal or update, must be
|
12345678910>>...182
