Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-10 06:01:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
baeb9a7d8b
linux/Documentation/subsystem-apis.rst

92 lines
1.5 KiB
ReStructuredText
Raw Normal View History

docs: Rewrite the front page The front page is the entry point to the documentation, especially for people who read it online. It's a big mess of everything we could think to toss into it. Rewrite the page with an eye toward simplicity and making it easy for readers to get going toward what they really want to find. This is only a beginning, but it makes our docs more approachable than before. Acked-by: Jani Nikula <jani.nikula@intel.com> Reviewed-by: David Vernet <void@manifault.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20220927160559.97154-3-corbet@lwn.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-09-27 16:05:54 +00:00
.. SPDX-License-Identifier: GPL-2.0
==============================
Kernel subsystem documentation
==============================
These books get into the details of how specific kernel subsystems work
from the point of view of a kernel developer. Much of the information here
is taken directly from the kernel source, with supplemental material added
as needed (or at least as we managed to add it — probably *not* all that is
needed).
docs: consolidate core subsystems to make the page more organized as requested Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230622071004.2934698-1-costa.shul@redhat.com
2023-06-22 07:10:03 +00:00
Core subsystems
---------------
.. toctree::
:maxdepth: 1
core-api/index
driver-api/index
mm/index
power/index
scheduler/index
timers/index
locking/index
docs: consolidate human interface subsystems to make the page more organized as requested Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230502015040.329394-1-costa.shul@redhat.com
2023-05-02 01:50:40 +00:00
Human interfaces
----------------
.. toctree::
:maxdepth: 1
input/index
hid/index
sound/index
gpu/index
fb/index
docs: move leds under section Human interfaces from uncategorized list Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20230913105519.675183-1-costa.shul@redhat.com>
2023-09-13 10:55:18 +00:00
leds/index
docs: consolidate human interface subsystems to make the page more organized as requested Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230502015040.329394-1-costa.shul@redhat.com
2023-05-02 01:50:40 +00:00
docs: consolidate networking interfaces to make the page more organized as requested Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230715165736.74816-1-costa.shul@redhat.com
2023-07-15 16:57:36 +00:00
Networking interfaces
---------------------
.. toctree::
:maxdepth: 1
networking/index
netlabel/index
infiniband/index
isdn/index
mhi/index
docs: consolidate storage interfaces to make the page more organized as requested Signed-off-by: Costa Shulyupin <costa.shul@redhat.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230618062937.481280-1-costa.shul@redhat.com
2023-06-18 06:29:37 +00:00
Storage interfaces
------------------
.. toctree::
:maxdepth: 1
filesystems/index
block/index
cdrom/index
scsi/index
target/index
docs: Fix subsystem APIs page so ungrouped entries have their own header The kernel subsystem APIs front page currently has four top-level groupings with headers, and then everything else that isn't grouped. But in the table-of-contents, ungrouped subsystems are indented as if they were part of the preceding grouping (currently "Storage interfaces"), which is confusing. Fix this by adding an "Other subsystems" header for the ungrouped subsystems. Fixes: 3c591cc954d5 ("docs: consolidate human interface subsystems") Signed-off-by: Michael Kelley <mhklinux@outlook.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20240125045941.123297-1-mhklinux@outlook.com
2024-01-25 04:59:41 +00:00
Other subsystems
----------------
docs: Rewrite the front page The front page is the entry point to the documentation, especially for people who read it online. It's a big mess of everything we could think to toss into it. Rewrite the page with an eye toward simplicity and making it easy for readers to get going toward what they really want to find. This is only a beginning, but it makes our docs more approachable than before. Acked-by: Jani Nikula <jani.nikula@intel.com> Reviewed-by: David Vernet <void@manifault.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20220927160559.97154-3-corbet@lwn.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-09-27 16:05:54 +00:00
**Fixme**: much more organizational work is needed here.
.. toctree::
:maxdepth: 1
accounting/index
cpu-freq/index
fpga/index
i2c/index
iio/index
pcmcia/index
spi/index
w1/index
watchdog/index
virt/index
hwmon/index
doc: add documentation for accel subsystem Add an introduction section for the accel subsystem. Most of the relevant data is in the DRM documentation, so the introduction only presents the why of the new subsystem, how are the compute accelerators exposed to user-space and what changes need to be done in a standard DRM driver to register it to the new accel subsystem. Signed-off-by: Oded Gabbay <ogabbay@kernel.org> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com> Reviewed-by: Dave Airlie <airlied@redhat.com> Acked-by: Thomas Zimmermann <tzimmermann@suse.de> Acked-by: Jacek Lawrynowicz <jacek.lawrynowicz@linux.intel.com> Tested-by: Jacek Lawrynowicz <jacek.lawrynowicz@linux.intel.com> Reviewed-by: Melissa Wen <mwen@igalia.com>
2022-11-19 19:54:20 +00:00
accel/index
docs: Rewrite the front page The front page is the entry point to the documentation, especially for people who read it online. It's a big mess of everything we could think to toss into it. Rewrite the page with an eye toward simplicity and making it easy for readers to get going toward what they really want to find. This is only a beginning, but it makes our docs more approachable than before. Acked-by: Jani Nikula <jani.nikula@intel.com> Reviewed-by: David Vernet <void@manifault.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20220927160559.97154-3-corbet@lwn.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-09-27 16:05:54 +00:00
security/index
crypto/index
bpf/index
usb/index
PCI/index
misc-devices/index
peci/index
platform/x86: wmi: Add documentation Add documentation for the WMI subsystem. The documentation describes both the ACPI WMI interface and the driver API for interacting with the WMI driver core. The information regarding the ACPI interface was retrieved from the Ubuntu kernel references and the Windows driver samples available on GitHub. The documentation is supposed to help driver developers writing WMI drivers, as many modern machines designed to run Windows provide an ACPI WMI interface. Signed-off-by: Armin Wolf <W_Armin@gmx.de> Tested-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20230424222939.208137-4-W_Armin@gmx.de Signed-off-by: Hans de Goede <hdegoede@redhat.com>
2023-04-24 22:29:38 +00:00
wmi/index
Documentation: Destage TEE subsystem documentation Add a separate documentation directory for TEE subsystem since it is a standalone subsystem which already offers devices consumed by multiple different subsystem drivers. Split overall TEE subsystem documentation modularly where: - The userspace API has been moved to Documentation/userspace-api/tee.rst. - The driver API has been moved to Documentation/driver-api/tee.rst. - The first module covers the overview of TEE subsystem. - The further modules are dedicated to different TEE implementations like: - OP-TEE - AMD-TEE - and so on for future TEE implementation support. Acked-by: Rijo Thomas <Rijo-john.Thomas@amd.com> Acked-by: Jens Wiklander <jens.wiklander@linaro.org> Signed-off-by: Sumit Garg <sumit.garg@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20231128072352.866859-1-sumit.garg@linaro.org
2023-11-28 07:23:52 +00:00
tee/index
Reference in New Issue Copy Permalink