Searched full:documentation (Results 1 – 25 of 6863) sorted by relevance
12345678910>>...275
/linux-6.8/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 | 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 | 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 | 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 …]
|
/linux-6.8/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 …]
|
/linux-6.8/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-6.8/ |
D | MAINTAINERS | 29 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 161 F: Documentation/filesystems/9p.rst 185 F: Documentation/scsi/aacraid.rst 190 F: Documentation/devicetree/bindings/power/supply/*ab8500* 282 F: Documentation/ABI/testing/configfs-acpi 283 F: Documentation/ABI/testing/sysfs-bus-acpi [all …]
|
/linux-6.8/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 …]
|
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 …]
|
/linux-6.8/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 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`` 。更改用戶空間接口的補丁應該抄送 91 19) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/`` 。 [all …]
|
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 …]
|
/linux-6.8/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/'|" 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-6.8/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-6.8/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-6.8/drivers/cpufreq/ |
D | Kconfig.x86 | 30 <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>. 98 For details, take a look at <file:Documentation/cpu-freq/>. 125 For details, take a look at <file:Documentation/cpu-freq/>. 135 For details, take a look at <file:Documentation/cpu-freq/>. 147 For details, take a look at <file:Documentation/cpu-freq/>. 157 For details, take a look at <file:Documentation/cpu-freq/>. 178 For details, take a look at <file:Documentation/cpu-freq/>. 204 For details, take a look at <file:Documentation/cpu-freq/>. [all …]
|
/linux-6.8/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 | 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) 24 _SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Docu… 80 # e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media 83 …cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2… 87 $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \ 100 YNL_INDEX:=$(srctree)/Documentation/networking/netlink_spec/index.rst 101 YNL_RST_DIR:=$(srctree)/Documentation/networking/netlink_spec [all …]
|
/linux-6.8/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-6.8/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-6.8/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-6.8/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-6.8/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-6.8/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 …]
|
/linux-6.8/Documentation/translations/ja_JP/ |
D | howto.rst | 6 This is a version of Documentation/process/howto.rst translated into Japanese. 23 Documentation/process/howto.rst 92 :ref:`Documentation/process/license-rules.rst <kernel_licensing>` 119 :ref:`Documentation/admin-guide/README.rst <readme>` 125 :ref:`Documentation/process/changes.rst <changes>` 130 :ref:`Documentation/process/coding-style.rst <codingstyle>` 137 :ref:`Documentation/process/submitting-patches.rst <codingstyle>` 158 :ref:`Documentation/process/stable-api-nonsense.rst <stable_api_nonsense>` 170 :ref:`Documentation/process/security-bugs.rst <securitybugs>` 175 :ref:`Documentation/process/management-style.rst <managementstyle>` [all …]
|
/linux-6.8/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
|
12345678910>>...275