Searched full:documentation (Results 1 – 25 of 2001) sorted by relevance
12345678910>>...81
| /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 | 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 | 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 …]
|
| D | checktransupdate.rst | 6 This script helps track the translation status of the documentation in
7 different locales, i.e., whether the documentation is up-to-date with
38 - ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
45 Documentation/dev-tools/kfence.rst
48 Documentation/translations/zh_CN/dev-tools/testing-overview.rst
49 commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
|
| /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 …]
|
| /Documentation/translations/zh_TW/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 …]
|
| /Documentation/translations/zh_TW/process/ |
| 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 …]
|
| /Documentation/translations/zh_CN/process/ |
| 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 …]
|
| /Documentation/rust/ |
| 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
|
| /Documentation/dev-tools/kunit/api/ |
| 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
|
| /Documentation/ |
| 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 …]
|
| D | Kconfig | 3 menu "Documentation" menu
6 bool "Warn if there's a missing documentation file"
18 The files under Documentation/ABI should follow what's
19 described at Documentation/ABI/README. Yet, as they're manually
|
| /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
|
| /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
|
| /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 …]
|
| /Documentation/translations/zh_CN/doc-guide/ |
| D | checktransupdate.rst | 5 :Original: Documentation/doc-guide/checktransupdate.rst
39 - ``./scripts/checktransupdate.py Documentation/translations/zh_CN/dev-tools/testing-overview.rst``
46 Documentation/dev-tools/kfence.rst
49 Documentation/translations/zh_CN/dev-tools/testing-overview.rst
50 commit 42fb9cfd5b18 ("Documentation: dev-tools: Add link to RV docs")
|
| /Documentation/process/ |
| 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 …]
|
| /Documentation/devicetree/bindings/power/ |
| 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
|
| /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.
|
| /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
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
|
| /Documentation/driver-api/surface_aggregator/clients/ |
| D | index.rst | 4 Client Driver Documentation
7 This is the documentation for client drivers themselves. Refer to
8 Documentation/driver-api/surface_aggregator/client.rst for documentation
|
| /Documentation/translations/ |
| D | index.rst | 30 documentation in their native language, but please bear in mind that the
31 *only* official documentation is the English one: :ref:`linux_doc`.
35 contributors - follow the evolution of the official documentation and they
40 documentation.
42 A translation is not a fork of the official documentation, therefore
44 English documentation. Any content addition, removal or update, must be
|
| /Documentation/userspace-api/media/ |
| D | index.rst | 14 Documentation/admin-guide/media/index.rst
18 Documentation/driver-api/media/index.rst
47 under the terms of the GNU Free Documentation License, Version 1.1 or
50 entitled "GNU Free Documentation License".
54 with GNU Free Documentation License Version 1.1 and with the
57 This documentation is free software; you can redistribute it and/or modify it
|
| /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 を参考にして必ずドキュメントを追加してください。
93 Documentation/fault-injection/ を参照してください。
|
| /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``.
|
12345678910>>...81