Home
last modified time | relevance | path

Searched full:documentation (Results 1 – 25 of 4257) sorted by relevance

12345678910>>...171

/linux/
H A DREADME10 * Report a bug: See Documentation/admin-guide/reporting-issues.rst
12 * Build the kernel: See Documentation/admin-guide/quickly-build-trimmed-linux.rst
15 Essential Documentation
20 * Building requirements: Documentation/process/changes.rst
21 * Code of Conduct: Documentation/process/code-of-conduct.rst
24 Documentation can be built with make htmldocs or viewed online at:
52 * Getting Started: Documentation/process/development-process.rst
53 * Your First Patch: Documentation/process/submitting-patches.rst
54 * Coding Style: Documentation/process/coding-style.rst
55 * Build System: Documentation/kbuild/index.rst
[all …]
H A DMAINTAINERS29 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/doc-guide/
H A Dcontributing.rst3 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 Dsphinx.rst4 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 Dmaintainer-profile.rst3 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 …]
H A Dkernel-doc.rst7 The Linux kernel source files may contain structured documentation
9 and design of the code. It is easier to keep documentation up-to-date
18 Documentation/rust/general-information.rst instead.
32 It is good practice to also provide kernel-doc formatted documentation
35 documentation for private (file ``static``) routines, for consistency of
49 that somebody changing the code will also change the documentation. The
55 documentation comments. For example::
59 The documentation format of ``.c`` files is also verified by the kernel build
67 Function documentation
177 Structure, union, and enumeration documentation
[all …]
/linux/drivers/gpu/drm/msm/registers/
H A Drules-fd.xsd8 <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 Dtesting-overview.rst5 :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/dev-tools/
H A Dtesting-overview.rst5 :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 Dsubmit-checklist.rst5 :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/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。
[all …]
H A Dhowto.rst7 :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 Dsubmit-checklist.rst3 :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/admin-guide/abi.rst (或 ``Documentation/ABI/README``)。
88 19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。
[all …]
H A Dhowto.rst5 :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/Documentation/devicetree/bindings/iio/adc/
H A Dadi,ad4000.yaml15 https://www.analog.com/media/en/technical-documentation/data-sheets/ad4000-4004-4008.pdf
16 https://www.analog.com/media/en/technical-documentation/data-sheets/ad4001-4005.pdf
17 https://www.analog.com/media/en/technical-documentation/data-sheets/ad4002-4006-4010.pdf
18 https://www.analog.com/media/en/technical-documentation/data-sheets/ad4003-4007-4011.pdf
19 https://www.analog.com/media/en/technical-documentation/data-sheets/ad4020-4021-4022.pdf
20 https://www.analog.com/media/en/technical-documentation/data-sheets/adaq4001.pdf
21 https://www.analog.com/media/en/technical-documentation/data-sheets/adaq4003.pdf
22 https://www.analog.com/media/en/technical-documentation/data-sheets/ad7685.pdf
23 https://www.analog.com/media/en/technical-documentation/data-sheets/ad7686.pdf
24 https://www.analog.com/media/en/technical-documentation/data-sheets/ad7687.pdf
[all …]
/linux/Documentation/translations/ja_JP/process/
H A Dsubmit-checklist.rst6 Documentation/translations/ja_JP/SubmitChecklist, which can be found
16 Documentation/process/submit-checklist.rst
25 これは、 Documentation/process/submitting-patches.rst およびその他の
41 2) Documentation/process/coding-style.rst に詳述されている一般的なスタイル
54 Documentation/kbuild/kconfig-language.rst の
69 2) 新規 ``/proc`` エントリーが、すべて ``Documentation/`` 以下に記載されて
73 ``Documentation/admin-guide/kernel-parameters.rst`` に記載されている。
78 5) 新規ユーザースペース・インターフェースが、すべて ``Documentation/ABI/``
79 以下に記載されている。詳しくは、 Documentation/admin-guide/abi.rst
80 (もしくは ``Documentation/ABI/README``) を参照。
[all …]
/linux/tools/docs/
H A Ddocumentation-file-ref-check4 # 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 Dindex.rst6 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 DMakefile2 # Makefile for Sphinx documentation
9 # Check for broken documentation file references
11 $(shell $(srctree)/tools/docs/documentation-file-ref-check --warn)
16 $(shell $(srctree)/tools/docs/get_abi.py --dir $(srctree)/Documentation/ABI validate)
55 # Common documentation targets
71 htmldocs-redirects: $(srctree)/Documentation/.renames.txt
75 $(Q)cd $(srctree); tools/docs/documentation-file-ref-check
81 … $(shell printf "%s\n" $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Doc…
84 @echo ' Linux kernel internal documentation in different formats from ReST:'
97 @echo ' Documentation'
[all …]
/linux/Documentation/process/
H A Dsubmit-checklist.rst10 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/admin-guide/abi.rst (or ``Documentation/ABI/README``)
61 ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
[all …]
/linux/drivers/iio/test/
H A DKconfig16 to the KUnit documentation in Documentation/dev-tools/kunit/.
28 to the KUnit documentation in Documentation/dev-tools/kunit/.
40 to the KUnit documentation in Documentation/dev-tools/kunit/.
52 to the KUnit documentation in Documentation/dev-tools/kunit/.
/linux/Documentation/hwmon/
H A Dmax6697.rst10 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6581.pdf
16 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6602.pdf
22 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6622.pdf
28 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6636.pdf
34 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6689.pdf
40 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6693.pdf
46 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6694.pdf
52 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6697.pdf
58 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6698.pdf
64 Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/max6699.pdf
/linux/Documentation/devicetree/bindings/mmc/
H A Dsdhci-st.txt4 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/drivers/cpufreq/
H A DKconfig.x8630 <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 Dtesting-overview.rst28 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/translations/zh_CN/scsi/
H A Dscsi-parameters.rst4 :Original: Documentation/scsi/scsi-parameters.rst
34 请查阅 Documentation/scsi/aha152x.rst。
40 请查阅 Documentation/scsi/aic7xxx.rst。
43 请查阅 Documentation/scsi/aic79xx.rst。
72 请查阅 Documentation/scsi/g_NCR5380.rst。
75 请查阅 Documentation/scsi/g_NCR5380.rst。
78 请查阅 Documentation/scsi/g_NCR5380.rst。
84 另请查阅 Documentation/scsi/st.rst。
115 请查阅 Documentation/scsi/st.rst。

12345678910>>...171