Searched full:documentation (Results 1 – 25 of 1798) sorted by relevance
12345678910>>...72
| /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.
55 (sphinx_2.4.4) $ pip install -r Documentation/sphinx/requirements.txt
[all …]
|
| D | kernel-doc.rst | 7 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 is verified by the kernel build when it is
64 Function documentation
174 Structure, union, and enumeration documentation
[all …]
|
| /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_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 ）
78 15) 所有新的 ``/proc`` 条目都记录在 ``Documentation/``
81 Documentation/admin-guide/kernel-parameters.rst 中。
85 18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息，
86 请参阅 ``Documentation/ABI/README`` 。更改用户空间接口的补丁应该抄送
89 19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。
[all …]
|
| 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 …]
|
| /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>`
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 …]
|
| /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/devicetree/bindings/power/ |
| D | wakeup-source.txt | 20 1. "gpio-key,wakeup" Documentation/devicetree/bindings/input/gpio-keys{,-polled}.txt
21 2. "has-tpo" Documentation/devicetree/bindings/rtc/rtc-opal.txt
22 3. "linux,wakeup" Documentation/devicetree/bindings/input/gpio-matrix-keypad.txt
23 Documentation/devicetree/bindings/mfd/tc3589x.txt
24 Documentation/devicetree/bindings/input/touchscreen/ads7846.txt
25 4. "linux,keypad-wakeup" Documentation/devicetree/bindings/input/qcom,pm8xxx-keypad.txt
26 5. "linux,input-wakeup" Documentation/devicetree/bindings/input/samsung-keypad.txt
27 6. "nvidia,wakeup-source" Documentation/devicetree/bindings/input/nvidia,tegra20-kbc.txt
|
| /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
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
109 of the documentation body, or may require some adjustments and/or conversion
|
| 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/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 …]
|
| /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/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/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/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/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
90 0) Please see Documentation/devicetree/bindings/ABI.rst for details
|
| /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``.
|
| /Documentation/userspace-api/media/ |
| D | index.rst | 14 Documentation/admin-guide/media/index.rst
18 Documentation/driver-api/media/index.rst
52 under the terms of the GNU Free Documentation License, Version 1.1 or
55 entitled "GNU Free Documentation License".
59 with GNU Free Documentation License Version 1.1 and with the
62 This documentation is free software; you can redistribute it and/or modify it
|
| /Documentation/rust/ |
| D | coding-guidelines.rst | 18 .. note:: Conventions on comments and documentation are not checked by
45 "Normal" comments (i.e. ``//``, rather than code documentation which starts
46 with ``///`` or ``//!``) are written in Markdown the same way as documentation
56 Furthermore, just like documentation, comments are capitalized at the beginning
64 Comments should not be used for documentation purposes: comments are intended
67 sometimes it is useful to use both comments and documentation at the same time.
68 For instance, for a ``TODO`` list or to comment on the documentation itself.
70 the line of documentation to be commented. For any other case, comments are
71 written after the documentation, e.g.:
98 in code documentation. ``# Safety`` sections specify the contract that callers
[all …]
|
| /Documentation/translations/zh_CN/doc-guide/ |
| D | maintainer-profile.rst | 5 :Original: Documentation/doc-guide/maintainer-profile.rst
12 文档“子系统”是内核文档和相关基础设施的中心协调点。它涵盖了 Documentation/ 下
13 的文件层级（Documentation/devicetree 除外）、scripts/ 下的各种实用程序，并且
17 保持对 Documentation/ 某些部分的控制，以便于可以更自由地做更改。除此之外，
|
12345678910>>...72