[bootlin/training-materials updates] master: Update kernel documentation links (5ae6a2be)
Michael Opdenacker
michael.opdenacker at bootlin.com
Fri Mar 12 12:56:34 CET 2021
Repository : https://github.com/bootlin/training-materials
On branch : master
Link : https://github.com/bootlin/training-materials/commit/5ae6a2bef977484c53b8f9b0b817eba2cc3b440a
>---------------------------------------------------------------
commit 5ae6a2bef977484c53b8f9b0b817eba2cc3b440a
Author: Michael Opdenacker <michael.opdenacker at bootlin.com>
Date: Fri Mar 12 12:56:34 2021 +0100
Update kernel documentation links
- Corresponding to the replacement of .txt files to .rst ones
- Only 2 left!
Signed-off-by: Michael Opdenacker <michael.opdenacker at bootlin.com>
>---------------------------------------------------------------
5ae6a2bef977484c53b8f9b0b817eba2cc3b440a
slides/initramfs/initramfs.tex | 4 ++--
slides/kernel-contribution/kernel-contribution.tex | 2 +-
slides/kernel-device-model/kernel-device-model.tex | 10 +++++-----
.../kernel-driver-development-concurrency.tex | 2 +-
.../kernel-driver-development-debugging.tex | 2 +-
.../kernel-driver-development-dma.tex | 4 ++--
.../kernel-driver-development-memory.tex | 2 +-
.../kernel-driver-development-modules.tex | 2 +-
slides/kernel-frameworks2/kernel-frameworks2.tex | 2 +-
slides/kernel-i2c/kernel-i2c.tex | 14 +++++++-------
slides/kernel-input/kernel-input.tex | 2 +-
slides/kernel-pinmuxing/kernel-pinmuxing.tex | 6 ++----
.../kernel-power-management-content.tex | 8 ++++----
.../kernel-source-code-drivers.tex | 4 ++--
.../sysdev-block-filesystems/sysdev-block-filesystems.tex | 2 +-
slides/sysdev-realtime/sysdev-realtime.tex | 2 +-
.../sysdev-root-filesystem-virtual-fs.tex | 4 ++--
17 files changed, 35 insertions(+), 37 deletions(-)
diff --git a/slides/initramfs/initramfs.tex b/slides/initramfs/initramfs.tex
index 65cb0f1b..11dd9671 100644
--- a/slides/initramfs/initramfs.tex
+++ b/slides/initramfs/initramfs.tex
@@ -51,8 +51,8 @@
root filesystem into the kernel image
\item Details (in kernel sources): \\
{\small
- \kerneldoctext{filesystems/ramfs-rootfs-initramfs.txt}\\
- \kerneldoctext{early-userspace/README}
+ \kerneldochtml{filesystems/ramfs-rootfs-initramfs}\\
+ \kerneldochtml{driver-api/early-userspace}
}
\end{itemize}
\end{frame}
diff --git a/slides/kernel-contribution/kernel-contribution.tex b/slides/kernel-contribution/kernel-contribution.tex
index 22f17a36..4b271cf3 100644
--- a/slides/kernel-contribution/kernel-contribution.tex
+++ b/slides/kernel-contribution/kernel-contribution.tex
@@ -25,7 +25,7 @@
\frametitle{How to Become a Kernel Developer?}
Recommended resources
\begin{itemize}
- \item See \kerneldoctext{SubmittingPatches} for guidelines
+ \item See \kerneldochtml{process/submitting-patches} for guidelines
and \url{https://kernelnewbies.org/UpstreamMerge} for very
helpful advice to have your changes merged upstream (by Rik van
Riel).
diff --git a/slides/kernel-device-model/kernel-device-model.tex b/slides/kernel-device-model/kernel-device-model.tex
index 380eb6ba..74e5e4b5 100644
--- a/slides/kernel-device-model/kernel-device-model.tex
+++ b/slides/kernel-device-model/kernel-device-model.tex
@@ -738,8 +738,8 @@ static struct platform_driver serial_omap_driver = {
\begin{itemize}
\item The compatible string and the associated properties define
what is called a {\em device tree binding}.
- \item {\em Device tree bindings} are all documented in
- \kerneldoctext{devicetree/bindings}.
+ \item {\em Device tree bindings} are all defined in
+ \kdir{devicetree/bindings}.
\item Since the Device Tree is normally part of the kernel ABI, the
{\em bindings} must remain compatible over time.
\begin{itemize}
@@ -793,9 +793,9 @@ static struct platform_driver serial_omap_driver = {
video: \url{https://frama.link/hkz8oUQK}
\item Kernel documentation
\begin{itemize}
- \item \kerneldoctext{driver-model/}
- \item \kerneldoctext{devicetree/}
- \item \kerneldoctext{filesystems/sysfs.txt}
+ \item \kerneldochtmldir{driver-api/driver-model}
+ \item \kerneldochtmldir{devicetree}
+ \item \kerneldochtml{filesystems/sysfs}
\end{itemize}
\item \url{https://devicetree.org}
\item The kernel source code
diff --git a/slides/kernel-driver-development-concurrency/kernel-driver-development-concurrency.tex b/slides/kernel-driver-development-concurrency/kernel-driver-development-concurrency.tex
index 79add433..03ce6eaf 100644
--- a/slides/kernel-driver-development-concurrency/kernel-driver-development-concurrency.tex
+++ b/slides/kernel-driver-development-concurrency/kernel-driver-development-concurrency.tex
@@ -236,7 +236,7 @@ static unsigned int ulite_tx_empty
\end{itemize}
\item Not suitable for production systems but acceptable overhead
in development.
- \item See \kerneldoctext{locking/lockdep-design.txt} for details
+ \item See \kerneldochtml{locking/lockdep-design} for details
\end{itemize}
\item Kernel Concurrency SANitizer framework
\begin{itemize}
diff --git a/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex b/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
index 5d09bf4e..894b323a 100644
--- a/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
+++ b/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
@@ -95,7 +95,7 @@ dev_info(&pdev->dev, "in probe\n");
\item The value of \code{/proc/sys/kernel/printk}, which allows to
change at runtime the priority above which messages are
displayed on the console. Details in
- \kerneldoctext{sysctl/kernel.txt}
+ \kerneldochtml{admin-guide/sysctl/kernel}
\end{itemize}
\end{itemize}
\end{frame}
diff --git a/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex b/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
index 497901d7..bc496957 100644
--- a/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
+++ b/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
@@ -100,8 +100,8 @@
\item Either allocating a buffer in a cache coherent area,
\item Or making sure caches are handled when required,
\item Managing the DMA mappings and IOMMU (if any).
- \item See \kerneldoctext{DMA-API.txt} for details about the
- Linux DMA generic API.
+ \item See \kerneldochtml{core-api/dma-api} for details about DMA
+ and the Linux DMA generic API.
\item Most subsystems (such as PCI or USB) supply their own DMA
API, derived from the generic one. May be sufficient for most
needs.
diff --git a/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex b/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
index bd53fde0..ad600ce0 100644
--- a/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
+++ b/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
@@ -54,7 +54,7 @@
(\kconfig{CONFIG_VMSPLIT_2G} or \kconfig{CONFIG_VMSPLIT_1G)}
$\Rightarrow$ reduce total user memory available for each process
\item Change for a 64 bit architecture ;-)\\
- See \kerneldoctext{x86/x86_64/mm.txt} for an example.
+ See \kerneldochtml{x86/x86_64/mm} for an example.
\item Activate \emph{highmem} support if available for your
architecture:
\begin{itemize}
diff --git a/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex b/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
index 8fea9f4b..650d8856 100644
--- a/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
+++ b/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
@@ -271,7 +271,7 @@ config USB_SERIAL_NAVMAN
\begin{itemize}
\item Run \code{make xconfig} and see your new options!
\item Run \code{make} and your new files are compiled!
- \item See \kerneldoctext{kbuild/} for details and more
+ \item See \kerneldochtmldir{kbuild} for details and more
elaborate examples like drivers with several source files, or
drivers in their own subdirectory, etc.
\end{itemize}
diff --git a/slides/kernel-frameworks2/kernel-frameworks2.tex b/slides/kernel-frameworks2/kernel-frameworks2.tex
index 03695b42..4563c4e6 100644
--- a/slides/kernel-frameworks2/kernel-frameworks2.tex
+++ b/slides/kernel-frameworks2/kernel-frameworks2.tex
@@ -390,7 +390,7 @@ static int xxxfb_probe (struct pci_dev *dev, const struct pci_device_id *ent)
\item When the device is unbound from the driver
\end{itemize}
\item Functions prefixed by \code{devm_}
- \item See \kerneldoctext{driver-model/devres.txt} for details
+ \item See \kerneldochtml{driver-api/driver-model/devres} for details
\end{itemize}
\end{frame}
diff --git a/slides/kernel-i2c/kernel-i2c.tex b/slides/kernel-i2c/kernel-i2c.tex
index 098cc7ba..bf4697fa 100644
--- a/slides/kernel-i2c/kernel-i2c.tex
+++ b/slides/kernel-i2c/kernel-i2c.tex
@@ -374,7 +374,7 @@ From \kfile{drivers/input/touchscreen/st1232.c}
\item Which means it first writes a one byte data command ({\em
Comm}), and then reads back one byte of data ({\em [Data]}).
\end{itemize}
- \item See \kerneldoctext{i2c/smbus-protocol} for details.
+ \item See \kerneldochtml{i2c/smbus-protocol} for details.
\end{itemize}
\end{frame}
@@ -437,17 +437,17 @@ From \kfile{drivers/input/touchscreen/st1232.c}
\begin{itemize}
\item \url{https://en.wikipedia.org/wiki/I2C}, general presentation
of the I2C protocol
- \item \kerneldoctext{i2c/}, details about Linux support for I2C
+ \item \kerneldochtmldir{i2c}, details about Linux support for I2C
\begin{itemize}
- \item \kerneldoctext{i2c/writing-clients}\\
+ \item \kerneldochtml{i2c/writing-clients}\\
How to write I2C kernel device drivers
- \item \kerneldoctext{i2c/dev-interface}\\
+ \item \kerneldochtml{i2c/dev-interface}\\
How to write I2C user-space device drivers
- \item \kerneldoctext{i2c/instantiating-devices}\\
+ \item \kerneldochtml{i2c/instantiating-devices}\\
How to instantiate devices
- \item \kerneldoctext{i2c/smbus-protocol}\\
+ \item \kerneldochtml{i2c/smbus-protocol}\\
Details on the SMBus functions
- \item \kerneldoctext{i2c/functionality}\\
+ \item \kerneldochtml{i2c/functionality}\\
How the functionality mechanism works
\end{itemize}
\item
diff --git a/slides/kernel-input/kernel-input.tex b/slides/kernel-input/kernel-input.tex
index 1ad55f83..bb8d206b 100644
--- a/slides/kernel-input/kernel-input.tex
+++ b/slides/kernel-input/kernel-input.tex
@@ -110,7 +110,7 @@ struct input_dev {
The events are sent by the driver to the event handler using
\code{input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value);}
\begin{itemize}
- \item The event types are documented in \kerneldoctext{input/event-codes.txt}
+ \item The event types are documented in \kerneldochtml{input/event-codes}
\item An event is composed by one or several input data changes
(packet of input data changes) such as the button state, the
relative or absolute position along an axis, etc..
diff --git a/slides/kernel-pinmuxing/kernel-pinmuxing.tex b/slides/kernel-pinmuxing/kernel-pinmuxing.tex
index d116a3a5..b0f8c075 100644
--- a/slides/kernel-pinmuxing/kernel-pinmuxing.tex
+++ b/slides/kernel-pinmuxing/kernel-pinmuxing.tex
@@ -36,8 +36,7 @@
the pin muxing must be described in the Device Tree.
\begin{itemize}
\item The exact Device Tree binding depends on each driver. Each
- binding is documented in
- \kerneldoctext{devicetree/bindings/pinctrl}.
+ binding is defined in \kdir{devicetree/bindings/pinctrl}.
\end{itemize}
\end{itemize}
\end{frame}
@@ -107,8 +106,7 @@ i2c0: i2c at f8014000 {
to the pin configuration it needs through a DT {\em phandle}.
\item The description of the configurations is specific to each {\em
pinctrl driver}. See
- \kerneldoctext{devicetree/bindings/pinctrl} for the DT
- bindings documentation.
+ \kdir{devicetree/bindings/pinctrl} for the pinctrl bindings.
\end{itemize}
\end{frame}
diff --git a/slides/kernel-power-management-content/kernel-power-management-content.tex b/slides/kernel-power-management-content/kernel-power-management-content.tex
index 9dd47476..c56b9861 100644
--- a/slides/kernel-power-management-content/kernel-power-management-content.tex
+++ b/slides/kernel-power-management-content/kernel-power-management-content.tex
@@ -202,7 +202,7 @@
\code{runtime_suspend()}, \code{runtime_resume()},
\code{runtime_idle()} in the \kstruct{dev_pm_ops}
structure in \kstruct{device_driver}.
- \item API and details on \kerneldoctext{power/runtime_pm.txt}
+ \item API and details on \kerneldochtml{power/runtime_pm}
\item See \kfile{drivers/net/ethernet/cadence/macb_main.c} again.
\end{itemize}
\end{frame}
@@ -215,7 +215,7 @@
physical power domain they belong to.
This sits at the same level as bus type for calling PM hooks.
\item All the devices in the same PD get the same state at the same time.
- \item Specifications and examples available at \kerneldoctext{devicetree/bindings/power/power_domain.txt}
+ \item Specifications and examples available at \kerneldochtml{devicetree/bindings/power/power_domain}
\item Driver example: \kfile{drivers/soc/rockchip/pm_domains.c}
(\kfunc{rockchip_pd_power_on}, \kfunc{rockchip_pd_power_off},
\kfunc{rockchip_pm_add_one_domain}...)
@@ -264,7 +264,7 @@
\item \code{setpolicy()} or \code{target()} to actually perform
the frequency change
\end{itemize}
- \item See \kerneldoctext{cpu-freq/} for useful explanations
+ \item See \kerneldochtmldir{cpu-freq} for useful explanations
\end{itemize}
\end{frame}
@@ -281,7 +281,7 @@
\item Machine interface for board configuration
\item sysfs interface for user space
\end{itemize}
- \item See \kerneldoctext{power/regulator/} in kernel sources.
+ \item See \kerneldochtmldir{power/regulator} in kernel sources.
\end{itemize}
\end{frame}
diff --git a/slides/kernel-source-code-drivers/kernel-source-code-drivers.tex b/slides/kernel-source-code-drivers/kernel-source-code-drivers.tex
index 09779c48..f4bc4bfd 100644
--- a/slides/kernel-source-code-drivers/kernel-source-code-drivers.tex
+++ b/slides/kernel-source-code-drivers/kernel-source-code-drivers.tex
@@ -213,8 +213,8 @@
\item Possibilities for user space device drivers:
\begin{itemize}
\item USB with {\em libusb}, \url{https://libusb.info/}
- \item SPI with {\em spidev}, \kerneldoctext{spi/spidev}
- \item I2C with {\em i2cdev}, \kerneldoctext{i2c/dev-interface}
+ \item SPI with {\em spidev}, \kerneldochtml{spi/spidev}
+ \item I2C with {\em i2cdev}, \kerneldochtml{i2c/dev-interface}
\item Memory-mapped devices with {\em UIO}, including interrupt
handling, \kerneldochtml{driver-api/uio-howto}
\end{itemize}
diff --git a/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex b/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
index 2bd298ca..3b361456 100644
--- a/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
+++ b/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
@@ -272,7 +272,7 @@ major minor #blocks name
instances you could have. Examples:\\
\code{mount -t tmpfs run /var/run}\\
\code{mount -t tmpfs shm /dev/shm}
- \item See \kerneldoctext{filesystems/tmpfs.txt} in kernel sources.
+ \item See \kerneldochtml{filesystems/tmpfs} in kernel sources.
\end{itemize}
\end{frame}
diff --git a/slides/sysdev-realtime/sysdev-realtime.tex b/slides/sysdev-realtime/sysdev-realtime.tex
index 9ae5466d..0ae9e191 100644
--- a/slides/sysdev-realtime/sysdev-realtime.tex
+++ b/slides/sysdev-realtime/sysdev-realtime.tex
@@ -939,7 +939,7 @@ timer_delete(timer_t timerid)
and performance issues in the kernel.
\begin{itemize}
- \item Very well documented in \kerneldoctext{trace/ftrace.txt}
+ \item Very well documented in \kerneldochtml{trace/ftrace}
\item Negligible overhead when tracing is not enabled at run-time.
\item Can be used to trace any kernel function!
\end{itemize}
diff --git a/slides/sysdev-root-filesystem-virtual-fs/sysdev-root-filesystem-virtual-fs.tex b/slides/sysdev-root-filesystem-virtual-fs/sysdev-root-filesystem-virtual-fs.tex
index 69a9591e..08738197 100644
--- a/slides/sysdev-root-filesystem-virtual-fs/sysdev-root-filesystem-virtual-fs.tex
+++ b/slides/sysdev-root-filesystem-virtual-fs/sysdev-root-filesystem-virtual-fs.tex
@@ -17,7 +17,7 @@
without the \code{proc} filesystem
\item Command to mount \code{proc}:\\
\code{mount -t proc nodev /proc}
- \item \kerneldoctext{filesystems/proc.txt} in the kernel sources
+ \item \kerneldochtml{filesystems/proc} in the kernel sources
\item \code{man proc}
\end{itemize}
\end{frame}
@@ -39,7 +39,7 @@
\item \code{/proc/sys} contains many files that can be written to
adjust kernel parameters
\begin{itemize}
- \item They are called {\em sysctl}. See \kerneldoctext{sysctl/}
+ \item They are called {\em sysctl}. See \kerneldochtmldir{admin-guide/sysctl}
in kernel sources.
\item Example (free the page cache and slab objects):\\
\code{echo 3 > /proc/sys/vm/drop_caches}
More information about the training-materials-updates
mailing list