[bootlin/training-materials updates] master: Rename "kerneldoc*" macros to "kdoc" (186d2b8f)
Michael Opdenacker
michael.opdenacker at bootlin.com
Tue Apr 20 15:23:10 CEST 2021
Repository : https://github.com/bootlin/training-materials
On branch : master
Link : https://github.com/bootlin/training-materials/commit/186d2b8f720437680ddf8ae64c77e404dd7bf2a1
>---------------------------------------------------------------
commit 186d2b8f720437680ddf8ae64c77e404dd7bf2a1
Author: Michael Opdenacker <michael.opdenacker at bootlin.com>
Date: Tue Apr 20 15:23:10 2021 +0200
Rename "kerneldoc*" macros to "kdoc"
- For consistency with other similar macros
Signed-off-by: Michael Opdenacker <michael.opdenacker at bootlin.com>
>---------------------------------------------------------------
186d2b8f720437680ddf8ae64c77e404dd7bf2a1
common/common.sty | 8 ++++----
.../boot-time-hardware-measurement.tex | 2 +-
labs/kernel-i2c-communication/kernel-i2c-communication.tex | 2 +-
.../kernel-i2c-input-interface.tex | 2 +-
slides/first-slides/first-slides.tex | 2 +-
slides/initramfs/initramfs.tex | 4 ++--
slides/kernel-contribution/kernel-contribution.tex | 4 ++--
slides/kernel-device-model/kernel-device-model.tex | 6 +++---
.../kernel-driver-development-concurrency.tex | 4 ++--
.../kernel-driver-development-debugging.tex | 12 ++++++------
.../kernel-driver-development-dma.tex | 4 ++--
.../kernel-driver-development-io-memory.tex | 2 +-
.../kernel-driver-development-memory.tex | 8 ++++----
.../kernel-driver-development-modules.tex | 4 ++--
slides/kernel-frameworks/kernel-frameworks.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 | 2 +-
.../kernel-power-management-content.tex | 12 ++++++------
.../kernel-source-code-drivers.tex | 10 +++++-----
.../sysdev-block-filesystems/sysdev-block-filesystems.tex | 2 +-
slides/sysdev-kernel-building/sysdev-kernel-building.tex | 2 +-
slides/sysdev-realtime/sysdev-realtime.tex | 2 +-
.../sysdev-root-filesystem-virtual-fs.tex | 4 ++--
25 files changed, 59 insertions(+), 59 deletions(-)
diff --git a/common/common.sty b/common/common.sty
index 5c8f0a41..6cffc99e 100644
--- a/common/common.sty
+++ b/common/common.sty
@@ -19,8 +19,8 @@
\newcommand\ksubarch[1]{\href{https://elixir.bootlin.com/linux/latest/source/arch/#1/}{\codelink{#1}}}
\newcommand\kconfig[1]{\href{https://elixir.bootlin.com/linux/latest/K/ident/#1}{\codelink{#1}}}
\newcommand\kconfigval[2]{\href{https://elixir.bootlin.com/linux/latest/K/ident/#1}{\codelink{#1=#2}}}
-\newcommand\kerneldoctext[1]{\href{https://kernel.org/doc/Documentation/#1}{\codelink{Documentation/#1}}}
-\newcommand\kerneldochtml[1]{\href{https://www.kernel.org/doc/html/latest/#1.html}{\codelink{#1}}}
-\newcommand\kerneldochtmldir[1]{\href{https://www.kernel.org/doc/html/latest/#1/}{\codelink{#1/}}}
-\newcommand\kerneldochtmlsection[3]{\href{https://www.kernel.org/doc/html/latest/#1/index.html\##2}{\codelink{#1} (section {\em #3})}}
+\newcommand\kdoctext[1]{\href{https://kernel.org/doc/Documentation/#1}{\codelink{Documentation/#1}}}
+\newcommand\kdochtml[1]{\href{https://www.kernel.org/doc/html/latest/#1.html}{\codelink{#1}}}
+\newcommand\kdochtmldir[1]{\href{https://www.kernel.org/doc/html/latest/#1/}{\codelink{#1/}}}
+\newcommand\kdochtmlsection[3]{\href{https://www.kernel.org/doc/html/latest/#1/index.html\##2}{\codelink{#1} (section {\em #3})}}
diff --git a/labs/boot-time-hardware-measurement/boot-time-hardware-measurement.tex b/labs/boot-time-hardware-measurement/boot-time-hardware-measurement.tex
index 12fc7d7e..6619d7c0 100644
--- a/labs/boot-time-hardware-measurement/boot-time-hardware-measurement.tex
+++ b/labs/boot-time-hardware-measurement/boot-time-hardware-measurement.tex
@@ -170,7 +170,7 @@ processing the first frame, it's easy to add code that configures our
custom GPIO line and drives it.
We are going to use the GPIO Sysfs interface (documented on
-\kerneldochtml{admin-guide/gpio/sysfs}). This interface is now
+\kdochtml{admin-guide/gpio/sysfs}). This interface is now
deprecated for several reasons, but it's convenient to use for
simple needs.
diff --git a/labs/kernel-i2c-communication/kernel-i2c-communication.tex b/labs/kernel-i2c-communication/kernel-i2c-communication.tex
index 41aba5d0..70edf27e 100644
--- a/labs/kernel-i2c-communication/kernel-i2c-communication.tex
+++ b/labs/kernel-i2c-communication/kernel-i2c-communication.tex
@@ -278,7 +278,7 @@ In this function:
an active wait, and instead lets the CPU run other tasks in the meantime.
You'll find interesting details on how to sleep or wait in kernel
code for specified durations in the kernel documentation:
- \kerneldochtml{timers/timers-howto}.}
+ \kdochtml{timers/timers-howto}.}
Such waiting time is needed to add time between the previous i2c
operation and the next one.
\item Write \code{0x00} to the bus. That will allow us to read
diff --git a/labs/kernel-i2c-input-interface/kernel-i2c-input-interface.tex b/labs/kernel-i2c-input-interface/kernel-i2c-input-interface.tex
index 03bf9545..bb4de8d6 100644
--- a/labs/kernel-i2c-input-interface/kernel-i2c-input-interface.tex
+++ b/labs/kernel-i2c-input-interface/kernel-i2c-input-interface.tex
@@ -256,7 +256,7 @@ the input device.
Add the below code to the \code{probe} routine:
\sourcecode{labs/kernel-i2c-input-interface/declare-x-and-y.c}
-See \kerneldochtml{input/input-programming} for details about
+See \kdochtml{input/input-programming} for details about
the \kfunc{input_set_abs_params} function.
For the joystick to be usable by the application, you will also
diff --git a/slides/first-slides/first-slides.tex b/slides/first-slides/first-slides.tex
index f66ea799..1b808e3a 100644
--- a/slides/first-slides/first-slides.tex
+++ b/slides/first-slides/first-slides.tex
@@ -62,7 +62,7 @@
\item Regular hyperlinks:\\
\url{https://kernel.org/}
\item Kernel documentation links:\\
- \kerneldochtml{dev-tools/kasan}
+ \kdochtml{dev-tools/kasan}
\item Links to kernel source files and directories:\\
\kdir{drivers/input} \\
\kfile{include/linux/fb.h}
diff --git a/slides/initramfs/initramfs.tex b/slides/initramfs/initramfs.tex
index eac63c77..387eee17 100644
--- a/slides/initramfs/initramfs.tex
+++ b/slides/initramfs/initramfs.tex
@@ -19,7 +19,7 @@
reasonable.
\end{itemize}
\item Details (in kernel sources): \\
- \kerneldochtml{filesystems/ramfs-rootfs-initramfs}\\
+ \kdochtml{filesystems/ramfs-rootfs-initramfs}\\
\end{itemize}
\end{frame}
@@ -61,7 +61,7 @@ bootz kernel-addr initramfs-addr dtb-addr
\item It can be a text file describing the contents of the initramfs
\end{itemize}
See the kernel documentation for details:
- \kerneldochtml{driver-api/early-userspace/early_userspace_support}
+ \kdochtml{driver-api/early-userspace/early_userspace_support}
\column{0.25\textwidth}
\includegraphics[width=0.9\textwidth]{slides/initramfs/initramfs.pdf}
\end{columns}
diff --git a/slides/kernel-contribution/kernel-contribution.tex b/slides/kernel-contribution/kernel-contribution.tex
index 4b271cf3..e7e238e1 100644
--- a/slides/kernel-contribution/kernel-contribution.tex
+++ b/slides/kernel-contribution/kernel-contribution.tex
@@ -9,7 +9,7 @@
\item Otherwise, or if this doesn't work, try to reproduce the
issue on the latest version of the kernel.
\item Make sure you investigate the issue as much as you can: see
- \kerneldochtml{admin-guide/bug-bisect}
+ \kdochtml{admin-guide/bug-bisect}
\item Check for previous bugs reports. Use web search engines,
accessing public mailing list archives.
\item If you're the first to face the issue, it's very useful for
@@ -25,7 +25,7 @@
\frametitle{How to Become a Kernel Developer?}
Recommended resources
\begin{itemize}
- \item See \kerneldochtml{process/submitting-patches} for guidelines
+ \item See \kdochtml{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 1563b0a8..b1880f30 100644
--- a/slides/kernel-device-model/kernel-device-model.tex
+++ b/slides/kernel-device-model/kernel-device-model.tex
@@ -988,9 +988,9 @@ examples:
video: \url{https://frama.link/hkz8oUQK}
\item Kernel documentation
\begin{itemize}
- \item \kerneldochtmldir{driver-api/driver-model}
- \item \kerneldochtmldir{devicetree}
- \item \kerneldochtml{filesystems/sysfs}
+ \item \kdochtmldir{driver-api/driver-model}
+ \item \kdochtmldir{devicetree}
+ \item \kdochtml{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 03ce6eaf..b4efeb45 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 \kerneldochtml{locking/lockdep-design} for details
+ \item See \kdochtml{locking/lockdep-design} for details
\end{itemize}
\item Kernel Concurrency SANitizer framework
\begin{itemize}
@@ -347,7 +347,7 @@ static unsigned int ulite_tx_empty
or for which sleeping would be too costly (critical sections)
\item Use atomic operations to protect integers or addresses
\end{itemize}
- See \kerneldochtml{kernel-hacking/locking} in kernel documentation
+ See \kdochtml{kernel-hacking/locking} in kernel documentation
for many details about kernel locking mechanisms.
\column[t]{0.35\textwidth}
\small
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 894b323a..dc925b42 100644
--- a/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
+++ b/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
@@ -65,7 +65,7 @@ dev_info(&pdev->dev, "in probe\n");
then these messages can dynamically be enabled on a per-file,
per-module or per-message basis
\begin{itemize}
- \item Details in \kerneldochtml{admin-guide/dynamic-debug-howto}
+ \item Details in \kdochtml{admin-guide/dynamic-debug-howto}
\item Very powerful feature to only get the debug messages you're
interested in.
\end{itemize}
@@ -90,12 +90,12 @@ dev_info(&pdev->dev, "in probe\n");
\begin{itemize}
\item The \code{loglevel} kernel parameter, which defines the
priority number below which messages are displayed on the console.
- Details in \kerneldochtml{admin-guide/kernel-parameters}.
+ Details in \kdochtml{admin-guide/kernel-parameters}.
\newline Examples: \code{loglevel=0}: no message, \code{loglevel=8}: all messages
\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
- \kerneldochtml{admin-guide/sysctl/kernel}
+ \kdochtml{admin-guide/sysctl/kernel}
\end{itemize}
\end{itemize}
\end{frame}
@@ -116,7 +116,7 @@ dev_info(&pdev->dev, "in probe\n");
\end{itemize}
\item First described on \url{https://lwn.net/Articles/115405/}
\item API documented in the Linux Kernel Filesystem API:
- \kerneldochtmlsection{filesystems}{the-debugfs-filesystem}
+ \kdochtmlsection{filesystems}{the-debugfs-filesystem}
{The debugfs filesystem}
\end{itemize}
\end{frame}
@@ -191,7 +191,7 @@ dev_info(&pdev->dev, "in probe\n");
\item \code{t}: shows the kernel stack of all running processes
\item You can even register your own!
\end{itemize}
- \item Detailed in \kerneldochtml{admin-guide/sysrq}
+ \item Detailed in \kdochtml{admin-guide/sysrq}
\end{itemize}
\end{frame}
@@ -211,7 +211,7 @@ dev_info(&pdev->dev, "in probe\n");
\frametitle{Using kgdb 1/2}
\begin{itemize}
\item Details available in the kernel documentation:
- \kerneldochtml{dev-tools/kgdb}
+ \kdochtml{dev-tools/kgdb}
\item Recommended to turn on \kconfig{CONFIG_FRAME_POINTER} to aid in
producing more reliable stack backtraces in \code{gdb}.
\item You must include a kgdb I/O driver. One of them is \code{kgdb} over
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 6c895d2d..ddbdfd8b 100644
--- a/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
+++ b/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
@@ -100,7 +100,7 @@
\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 \kerneldochtml{core-api/dma-api} for details about DMA
+ \item See \kdochtml{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
@@ -240,6 +240,6 @@ void dma_unmap_single(struct device *dev, dma_addr_t handdle,
\item Example usage of the slave API: look at the code
for \kfunc{stm32_i2c_prep_dma_xfer}.
\end{itemize}
- Details in kernel documentation: \kerneldochtml{driver-api/dmaengine/client}
+ Details in kernel documentation: \kdochtml{driver-api/dmaengine/client}
\end{frame}
diff --git a/slides/kernel-driver-development-io-memory/kernel-driver-development-io-memory.tex b/slides/kernel-driver-development-io-memory/kernel-driver-development-io-memory.tex
index dfb88447..3093739d 100644
--- a/slides/kernel-driver-development-io-memory/kernel-driver-development-io-memory.tex
+++ b/slides/kernel-driver-development-io-memory/kernel-driver-development-io-memory.tex
@@ -249,7 +249,7 @@ writel(c & 0xff, port->membase + 4);
\item \kfunc{wmb} is a write memory barrier
\item \kfunc{mb} is a read-write memory barrier
\item Starts to be a problem with CPUs that reorder instructions and
- with SMP. See \kerneldoctext{memory-barriers.txt} for details.
+ with SMP. See \kdoctext{memory-barriers.txt} for details.
\end{itemize}
\item Note that \kfunc{readl}, \kfunc{writel} and similar functions
already contain barriers (safer), while the raw ones don't.
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 ad600ce0..b90327fd 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 \kerneldochtml{x86/x86_64/mm} for an example.
+ See \kdochtml{x86/x86_64/mm} for an example.
\item Activate \emph{highmem} support if available for your
architecture:
\begin{itemize}
@@ -184,7 +184,7 @@
for DMA transfers. See our DMA chapter.
\end{itemize}
\item Others are defined in \kfile{include/linux/gfp.h}.\\
- See also the documentation in \kerneldochtml{core-api/memory-allocation}
+ See also the documentation in \kdochtml{core-api/memory-allocation}
\end{itemize}
\end{frame}
@@ -363,13 +363,13 @@ kfree(work);
(64 bit), \code{powerpc} (32 bit), \code{s390} and \code{xtensa} so far
(Linux 5.11 status), but will help to improve architecture independent
code anyway.
- \item See \kerneldochtml{dev-tools/kasan} for details.
+ \item See \kdochtml{dev-tools/kasan} for details.
\end{itemize}
\item \code{Kmemleak}
\begin{itemize}
\item Dynamic checker for memory leaks
\item This feature is available for all architectures.
- \item See \kerneldochtml{dev-tools/kmemleak} for details.
+ \item See \kdochtml{dev-tools/kmemleak} for details.
\end{itemize}
\end{itemize}
Both have a significant overhead. Only use them in development!
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 650d8856..341735bc 100644
--- a/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
+++ b/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
@@ -119,7 +119,7 @@ MODULE_AUTHOR("William Shakespeare");
\item Used by kernel developers to identify issues coming from
proprietary drivers, which they can't do anything about
(“Tainted” kernel notice in kernel crashes and oopses).
- \item See \kerneldochtml{admin-guide/tainted-kernels}
+ \item See \kdochtml{admin-guide/tainted-kernels}
for details about \code{tainted} flag values.
\item Useful for users to check that their system is 100\% free
(for the kernel, check \code{/proc/sys/kernel/tainted}; run
@@ -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 \kerneldochtmldir{kbuild} for details and more
+ \item See \kdochtmldir{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-frameworks/kernel-frameworks.tex b/slides/kernel-frameworks/kernel-frameworks.tex
index 1a66732f..895b3fbf 100644
--- a/slides/kernel-frameworks/kernel-frameworks.tex
+++ b/slides/kernel-frameworks/kernel-frameworks.tex
@@ -50,6 +50,6 @@
the various devices they manage.
\item Most major and minor numbers are statically allocated, and
identical across all Linux systems.
- \item They are defined in \kerneldochtml{admin-guide/devices}.
+ \item They are defined in \kdochtml{admin-guide/devices}.
\end{itemize}
\end{frame}
diff --git a/slides/kernel-frameworks2/kernel-frameworks2.tex b/slides/kernel-frameworks2/kernel-frameworks2.tex
index 969537db..a2497bc5 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 \kerneldochtml{driver-api/driver-model/devres} for details
+ \item See \kdochtml{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 bf4697fa..e853fd6f 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 \kerneldochtml{i2c/smbus-protocol} for details.
+ \item See \kdochtml{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 \kerneldochtmldir{i2c}, details about Linux support for I2C
+ \item \kdochtmldir{i2c}, details about Linux support for I2C
\begin{itemize}
- \item \kerneldochtml{i2c/writing-clients}\\
+ \item \kdochtml{i2c/writing-clients}\\
How to write I2C kernel device drivers
- \item \kerneldochtml{i2c/dev-interface}\\
+ \item \kdochtml{i2c/dev-interface}\\
How to write I2C user-space device drivers
- \item \kerneldochtml{i2c/instantiating-devices}\\
+ \item \kdochtml{i2c/instantiating-devices}\\
How to instantiate devices
- \item \kerneldochtml{i2c/smbus-protocol}\\
+ \item \kdochtml{i2c/smbus-protocol}\\
Details on the SMBus functions
- \item \kerneldochtml{i2c/functionality}\\
+ \item \kdochtml{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 bb8d206b..d92a162c 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 \kerneldochtml{input/event-codes}
+ \item The event types are documented in \kdochtml{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 b0f8c075..b6d7100a 100644
--- a/slides/kernel-pinmuxing/kernel-pinmuxing.tex
+++ b/slides/kernel-pinmuxing/kernel-pinmuxing.tex
@@ -59,7 +59,7 @@
state. The name \code{default} is special, and is automatically
selected by a device driver, without having to make an explicit
{\em pinctrl} function call.
- \item See \kerneldoctext{devicetree/bindings/pinctrl/pinctrl-bindings.txt}
+ \item See \kdoctext{devicetree/bindings/pinctrl/pinctrl-bindings.txt}
for details.
\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 ca46f425..249b98cd 100644
--- a/slides/kernel-power-management-content/kernel-power-management-content.tex
+++ b/slides/kernel-power-management-content/kernel-power-management-content.tex
@@ -169,7 +169,7 @@
transition operations
\item Platform-independent governors
\item Available in particular for x86/ACPI and most ARM SoCs
- \item See \kerneldochtml{admin-guide/pm/cpuidle} in kernel documentation.
+ \item See \kdochtml{admin-guide/pm/cpuidle} in kernel documentation.
\end{itemize}
\end{itemize}
\end{frame}
@@ -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 \kerneldochtml{power/runtime_pm}
+ \item API and details on \kdochtml{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 \kerneldochtml{devicetree/bindings/power/power_domain}
+ \item Specifications and examples available at \kdochtml{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 \kerneldochtmldir{cpu-freq} for useful explanations
+ \item See \kdochtmldir{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 \kerneldochtmldir{power/regulator} in kernel sources.
+ \item See \kdochtmldir{power/regulator} in kernel sources.
\end{itemize}
\end{frame}
@@ -308,7 +308,7 @@
\begin{frame}
\frametitle{Useful resources}
\begin{itemize}
- \item \kerneldochtmldir{power} in kernel documentation.
+ \item \kdochtmldir{power} in kernel documentation.
\begin{itemize}
\item Will give you many useful details.
\end{itemize}
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 f4bc4bfd..f2072920 100644
--- a/slides/kernel-source-code-drivers/kernel-source-code-drivers.tex
+++ b/slides/kernel-source-code-drivers/kernel-source-code-drivers.tex
@@ -77,7 +77,7 @@
change: works great for mainline code.
\item An out-of-tree driver compiled for a given version may no
longer compile or work on a more recent one.
- \item See \kerneldochtml{process/stable-api-nonsense} in kernel sources for
+ \item See \kdochtml{process/stable-api-nonsense} in kernel sources for
reasons why.
\item Of course, the kernel to user space API does not change (system
calls, \code{/proc}, \code{/sys}), as it would break existing
@@ -141,7 +141,7 @@
the kernel or not?
\begin{itemize}
\item The general opinion of the kernel community is that
- proprietary modules are bad: \kerneldochtml{process/kernel-driver-statement}
+ proprietary modules are bad: \kdochtml{process/kernel-driver-statement}
\item From a legal point of view, each driver is probably a
different case
\item Is it really useful to keep your drivers secret?
@@ -213,10 +213,10 @@
\item Possibilities for user space device drivers:
\begin{itemize}
\item USB with {\em libusb}, \url{https://libusb.info/}
- \item SPI with {\em spidev}, \kerneldochtml{spi/spidev}
- \item I2C with {\em i2cdev}, \kerneldochtml{i2c/dev-interface}
+ \item SPI with {\em spidev}, \kdochtml{spi/spidev}
+ \item I2C with {\em i2cdev}, \kdochtml{i2c/dev-interface}
\item Memory-mapped devices with {\em UIO}, including interrupt
- handling, \kerneldochtml{driver-api/uio-howto}
+ handling, \kdochtml{driver-api/uio-howto}
\end{itemize}
\item Certain classes of devices (printers, scanners, 2D/3D graphics
acceleration) are typically handled partly in kernel space, partly
diff --git a/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex b/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
index 0e6b0f46..b0b5f890 100644
--- a/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
+++ b/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
@@ -274,7 +274,7 @@ major minor #blocks name
tmpfs instance is different). Examples:\\
\code{mount -t tmpfs run /var/run}\\
\code{mount -t tmpfs shm /dev/shm}
- \item See \kerneldochtml{filesystems/tmpfs} in kernel sources.
+ \item See \kdochtml{filesystems/tmpfs} in kernel sources.
\end{itemize}
\end{frame}
diff --git a/slides/sysdev-kernel-building/sysdev-kernel-building.tex b/slides/sysdev-kernel-building/sysdev-kernel-building.tex
index edb130d5..d8543be0 100644
--- a/slides/sysdev-kernel-building/sysdev-kernel-building.tex
+++ b/slides/sysdev-kernel-building/sysdev-kernel-building.tex
@@ -634,7 +634,7 @@ tools (\code{gcc}, \code{as}, \code{ld}, \code{objcopy}, \code{strip}...).
\item \code{console=} for the destination of kernel messages
\item Example: \code{console=ttyS0 root=/dev/mmcblk0p2 rootwait}
\item Many more exist. The most important ones are documented
- in \kerneldochtml{admin-guide/kernel-parameters} in kernel
+ in \kdochtml{admin-guide/kernel-parameters} in kernel
documentation.
\end{itemize}
\item This kernel command line can be, in order of priority (highest
diff --git a/slides/sysdev-realtime/sysdev-realtime.tex b/slides/sysdev-realtime/sysdev-realtime.tex
index 4d27fea0..5a00837c 100644
--- a/slides/sysdev-realtime/sysdev-realtime.tex
+++ b/slides/sysdev-realtime/sysdev-realtime.tex
@@ -943,7 +943,7 @@ timer_delete(timer_t timerid)
and performance issues in the kernel.
\begin{itemize}
- \item Very well documented in \kerneldochtml{trace/ftrace}
+ \item Very well documented in \kdochtml{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 08738197..83a3b1f6 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 \kerneldochtml{filesystems/proc} in the kernel sources
+ \item \kdochtml{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 \kerneldochtmldir{admin-guide/sysctl}
+ \item They are called {\em sysctl}. See \kdochtmldir{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