[FE training-materials-updates] Update kernel documentation links
Michael Opdenacker
michael.opdenacker at free-electrons.com
Mon Dec 19 08:15:48 CET 2016
Repository : git://git.free-electrons.com/training-materials.git
On branch : master
Link : http://git.free-electrons.com/training-materials/commit/?id=0a337b0af8dfc505cff5cc3237e297370b359a6c
>---------------------------------------------------------------
commit 0a337b0af8dfc505cff5cc3237e297370b359a6c
Author: Michael Opdenacker <michael.opdenacker at free-electrons.com>
Date: Mon Dec 19 08:15:48 2016 +0100
Update kernel documentation links
- Now pointing directly to the right path under
https://kernel.org/doc/
Signed-off-by: Michael Opdenacker <michael.opdenacker at free-electrons.com>
>---------------------------------------------------------------
0a337b0af8dfc505cff5cc3237e297370b359a6c
common/beamerthemeFreeElectrons.sty | 4 ++--
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 | 8 ++++----
.../kernel-driver-development-concurrency.tex | 2 +-
.../kernel-driver-development-debugging.tex | 12 ++++++------
.../kernel-driver-development-dma.tex | 2 +-
.../kernel-driver-development-io-memory.tex | 2 +-
.../kernel-driver-development-memory.tex | 6 +++---
.../kernel-driver-development-modules.tex | 2 +-
slides/kernel-frameworks/kernel-frameworks.tex | 2 +-
slides/kernel-frameworks2/kernel-frameworks2.tex | 2 +-
slides/kernel-i2c/kernel-i2c.tex | 4 ++--
slides/kernel-input/kernel-input.tex | 2 +-
slides/kernel-pinmuxing/kernel-pinmuxing.tex | 6 +++---
.../kernel-power-management-content.tex | 14 +++++++-------
.../kernel-resources-references.tex | 6 ++----
.../kernel-serial-drivers-content.tex | 4 ++--
.../kernel-source-code-drivers.tex | 8 ++++----
.../kernel-source-code-layout.tex | 8 ++++----
.../sysdev-block-filesystems/sysdev-block-filesystems.tex | 2 +-
.../sysdev-linux-intro-cross-compilation.tex | 2 +-
slides/sysdev-realtime/sysdev-realtime.tex | 2 +-
.../sysdev-root-filesystem-virtual-fs.tex | 4 ++--
slides/sysdev-udev/sysdev-udev.tex | 2 +-
26 files changed, 57 insertions(+), 59 deletions(-)
diff --git a/common/beamerthemeFreeElectrons.sty b/common/beamerthemeFreeElectrons.sty
index 1b10f7e..de9ad02 100644
--- a/common/beamerthemeFreeElectrons.sty
+++ b/common/beamerthemeFreeElectrons.sty
@@ -38,8 +38,8 @@
\newcommand\kpath[1]{\href{http://lxr.free-electrons.com/source/#1}{\code{#1}}}
\newcommand\kpathversion[2]{\href{http://lxr.free-electrons.com/source/#1?v=#2}{\code{#1}}}
\newcommand\ksubarch[1]{\href{http://lxr.free-electrons.com/source/arch/#1}{\code{#1}}}
-\newcommand\kerneldoc[1]{{\href{http://free-electrons.com/kerneldoc/latest/#1}{\code{Documentation/#1}}}
-}
+\newcommand\kerneldoctext[1]{\href{https://kernel.org/doc/Documentation/#1}{\code{Documentation/#1}}}
+\newcommand\kerneldocbook[1]{\href{https://kernel.org/doc/htmldocs/#1}{\code{DocBook/#1}}}
\usepackage{listings}
\usepackage{environ}
diff --git a/slides/first-slides/first-slides.tex b/slides/first-slides/first-slides.tex
index 98d7648..b6886b3 100644
--- a/slides/first-slides/first-slides.tex
+++ b/slides/first-slides/first-slides.tex
@@ -60,7 +60,7 @@
\item Regular hyperlinks:\\
\url{http://kernel.org/}
\item Kernel documentation links:\\
- \kerneldoc{kmemcheck.txt}
+ \kerneldoctext{kmemcheck.txt}
\item Links to kernel source files and directories:\\
\kpath{drivers/input} \\
\kpath{include/linux/fb.h}
diff --git a/slides/initramfs/initramfs.tex b/slides/initramfs/initramfs.tex
index a727ecf..85e7f0f 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
- \kerneldoc{filesystems/ramfs-rootfs-initramfs.txt}\\
- \kerneldoc{early-userspace/README}
+ \kerneldoctext{filesystems/ramfs-rootfs-initramfs.txt}\\
+ \kerneldoctext{early-userspace/README}
}
\end{itemize}
\end{frame}
diff --git a/slides/kernel-contribution/kernel-contribution.tex b/slides/kernel-contribution/kernel-contribution.tex
index 329810b..c5616d6 100644
--- a/slides/kernel-contribution/kernel-contribution.tex
+++ b/slides/kernel-contribution/kernel-contribution.tex
@@ -39,7 +39,7 @@
\begin{itemize}
\item First make sure you're using the latest version
\item Make sure you investigate the issue as much as you can: see
- \kerneldoc{BUG-HUNTING}
+ \kerneldoctext{BUG-HUNTING}
\item Check for previous bugs reports. Use web search engines,
accessing public mailing list archives.
\item If the subsystem you report a bug on has a mailing list, use
@@ -53,7 +53,7 @@
\frametitle{How to Become a Kernel Developer?}
Recommended resources
\begin{itemize}
- \item See \kerneldoc{SubmittingPatches} for guidelines
+ \item See \kerneldoctext{SubmittingPatches} for guidelines
and \url{http://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 1d4d17f..b2c5e04 100644
--- a/slides/kernel-device-model/kernel-device-model.tex
+++ b/slides/kernel-device-model/kernel-device-model.tex
@@ -683,7 +683,7 @@ static struct platform_driver serial_omap_driver = {
\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
- \kerneldoc{devicetree/bindings}.
+ \kerneldoctext{devicetree/bindings}.
\item Since the Device Tree is normally part of the kernel ABI, the
{\em bindings} must remain compatible over-time.
\begin{itemize}
@@ -733,9 +733,9 @@ static struct platform_driver serial_omap_driver = {
\url{http://j.mp/1jQU6NR}
\item Kernel documentation
\begin{itemize}
- \item \kerneldoc{driver-model/}
- \item \kerneldoc{devicetree/}
- \item \kerneldoc{filesystems/sysfs.txt}
+ \item \kerneldoctext{driver-model/}
+ \item \kerneldoctext{devicetree/}
+ \item \kerneldoctext{filesystems/sysfs.txt}
\end{itemize}
\item \url{http://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 4298575..268e8c6 100644
--- a/slides/kernel-driver-development-concurrency/kernel-driver-development-concurrency.tex
+++ b/slides/kernel-driver-development-concurrency/kernel-driver-development-concurrency.tex
@@ -223,7 +223,7 @@ static unsigned int ulite_tx_empty
\item Not suitable for production systems but acceptable overhead
in development.
\end{itemize}
- \item See \kerneldoc{locking/lockdep-design.txt} for details
+ \item See \kerneldoctext{locking/lockdep-design.txt} for details
\end{itemize}
\end{frame}
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 4186539..26ff17c 100644
--- a/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
+++ b/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
@@ -63,7 +63,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 See \kerneldoc{dynamic-debug-howto.txt} for details
+ \item See \kerneldoctext{dynamic-debug-howto.txt} for details
\item Very powerful feature to only get the debug messages you're
interested in.
\end{itemize}
@@ -88,11 +88,11 @@ dev_info(&pdev->dev, "in probe\n");
\begin{itemize}
\item The \code{loglevel} kernel parameter, which defines the
priority above which messages are displayed on the console. See
- \kerneldoc{kernel-parameters.txt} for details.
+ \kerneldoctext{kernel-parameters.txt} for details.
\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. See
- \kerneldoc{sysctl/kernel.txt} for details.
+ \kerneldoctext{sysctl/kernel.txt} for details.
\end{itemize}
\end{itemize}
\end{frame}
@@ -114,7 +114,7 @@ dev_info(&pdev->dev, "in probe\n");
\item First described on \url{http://lwn.net/Articles/115405/}
\item API documented in the Linux Kernel Filesystem API:
\begin{itemize}
- \item \kerneldoc{DocBook/filesystems/}
+ \item \kerneldocbook{filesystems/}
\end{itemize}
\end{itemize}
\end{frame}
@@ -187,7 +187,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 \kerneldoc{sysrq.txt}
+ \item Detailed in \kerneldoctext{sysrq.txt}
\end{itemize}
\end{frame}
@@ -206,7 +206,7 @@ dev_info(&pdev->dev, "in probe\n");
\frametitle{Using kgdb 1/2}
\begin{itemize}
\item Details available in the kernel documentation:
- \kerneldoc{DocBook/kgdb/}
+ \kerneldocbook{kgdb/}
\item Recommended to turn on \code{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 8ff5d39..3c57e82 100644
--- a/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
+++ b/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
@@ -93,7 +93,7 @@
\item Either allocating a buffer in a cache coherent area,
\item Or making sure caches are flushed when required,
\item Managing the DMA mappings and IOMMU (if any).
- \item See \kerneldoc{DMA-API.txt} for details about the
+ \item See \kerneldoctext{DMA-API.txt} for details about 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
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 3432d74..edcde3d 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
@@ -237,7 +237,7 @@ __raw_writel(1 << KS8695_IRQ_UART_TX,
\end{itemize}
\item Starts to be a problem with CPUs that reorder instructions and
SMP.
- \item See \kerneldoc{memory-barriers.txt} for details
+ \item See \kerneldoctext{memory-barriers.txt} for details
\end{itemize}
\end{frame}
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 916b2e5..8c34786 100644
--- a/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
+++ b/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
@@ -55,7 +55,7 @@
(\code{CONFIG_VMSPLIT_3G)} $\Rightarrow$ reduces total memory
available for each process
\item Change for a 64 bit architecture ;-) See
- \kerneldoc{x86/x86_64/mm.txt} for an example.
+ \kerneldoctext{x86/x86_64/mm.txt} for an example.
\item Activate \emph{highmem} support if available for your
architecture:
\begin{itemize}
@@ -372,13 +372,13 @@ kfree(work);
\item Dynamic checker for access to uninitialized memory.
\item Only available on \code{x86} so far (Linux 4.9 status), but will
help to improve architecture independent code anyway.
- \item See \kerneldoc{kmemcheck.txt} for details.
+ \item See \kerneldoctext{kmemcheck.txt} 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 \kerneldoc{kmemleak.txt} for details.
+ \item See \kerneldoctext{kmemleak.txt} 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 33973e9..9606f61 100644
--- a/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
+++ b/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
@@ -257,7 +257,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 \kerneldoc{kbuild/} for details and more
+ \item See \kerneldoctext{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 db6b4dc..ad536ba 100644
--- a/slides/kernel-frameworks/kernel-frameworks.tex
+++ b/slides/kernel-frameworks/kernel-frameworks.tex
@@ -50,6 +50,6 @@
device (when there are for example several serial ports)
\item Most major and minor numbers are statically allocated, and
identical across all Linux systems.
- \item They are defined in \kerneldoc{devices.txt}.
+ \item They are defined in \kerneldoctext{devices.txt}.
\end{itemize}
\end{frame}
diff --git a/slides/kernel-frameworks2/kernel-frameworks2.tex b/slides/kernel-frameworks2/kernel-frameworks2.tex
index 1acd6b4..d8cb165 100644
--- a/slides/kernel-frameworks2/kernel-frameworks2.tex
+++ b/slides/kernel-frameworks2/kernel-frameworks2.tex
@@ -527,7 +527,7 @@ static int serial_imx_remove(struct platform_device *pdev)
\item We will see many \code{devm_} functions in the subsystems
that we will study.
\end{itemize}
- See \kerneldoc{driver-model/devres.txt} for implementation details
+ See \kerneldoctext{driver-model/devres.txt} for implementation details
and available functions.
\end{frame}
diff --git a/slides/kernel-i2c/kernel-i2c.tex b/slides/kernel-i2c/kernel-i2c.tex
index de8e930..295ef51 100644
--- a/slides/kernel-i2c/kernel-i2c.tex
+++ b/slides/kernel-i2c/kernel-i2c.tex
@@ -325,7 +325,7 @@ error = i2c_transfer(client->adapter, msg, 2);
\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 \kerneldoc{i2c/smbus-protocol} for details.
+ \item See \kerneldoctext{i2c/smbus-protocol} for details.
\end{itemize}
\end{frame}
@@ -388,7 +388,7 @@ error = i2c_transfer(client->adapter, msg, 2);
\begin{itemize}
\item \url{http://en.wikipedia.org/wiki/I2C}, general presentation
of the I2C protocol
- \item \kerneldoc{i2c/}, details about the Linux support for I2C
+ \item \kerneldoctext{i2c/}, details about the Linux support for I2C
\begin{itemize}
\item \code{writing-clients}, how to write I2C device drivers
\item \code{instantiating-devices}, how to instantiate devices
diff --git a/slides/kernel-input/kernel-input.tex b/slides/kernel-input/kernel-input.tex
index a522111..e67620f 100644
--- a/slides/kernel-input/kernel-input.tex
+++ b/slides/kernel-input/kernel-input.tex
@@ -112,7 +112,7 @@ struct input_dev {
\item 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 \kerneldoc{input/event-codes.txt}
+ \item The event types are documented in \kerneldoctext{input/event-codes.txt}
\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 d0a4a1a..3c7d963 100644
--- a/slides/kernel-pinmuxing/kernel-pinmuxing.tex
+++ b/slides/kernel-pinmuxing/kernel-pinmuxing.tex
@@ -37,7 +37,7 @@
\begin{itemize}
\item The exact Device Tree binding depends on each driver. Each
binding is documented in
- \kerneldoc{devicetree/bindings/pinctrl}.
+ \kerneldoctext{devicetree/bindings/pinctrl}.
\end{itemize}
\end{itemize}
\end{frame}
@@ -68,7 +68,7 @@ i2c at 11000 {
...
};
\end{minted}
-\item See \kerneldoc{devicetree/bindings/pinctrl/pinctrl-bindings.txt}
+\item See \kerneldoctext{devicetree/bindings/pinctrl/pinctrl-bindings.txt}
for details.
\end{itemize}
\end{frame}
@@ -89,7 +89,7 @@ i2c at 11000 {
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
- \kerneldoc{devicetree/bindings/pinctrl} for the DT
+ \kerneldoctext{devicetree/bindings/pinctrl} for the DT
bindings documentation.
\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 776b673..b8ef348 100644
--- a/slides/kernel-power-management-content/kernel-power-management-content.tex
+++ b/slides/kernel-power-management-content/kernel-power-management-content.tex
@@ -21,7 +21,7 @@
system
\item Allows to reference count clock users and to shutdown the
unused clocks to save power
- \item Simple API described in \kerneldoc{DocBook/kernel-api/clk.html}.
+ \item Simple API described in \kerneldocbook{kernel-api/clk.html}.
\begin{itemize}
\item \kfunc{clk_get} to get a reference to a clock
\item \kfunc{clk_enable} to start the clock
@@ -137,7 +137,7 @@
\item New hooks must be added to the drivers:
\code{runtime_suspend()}, \code{runtime_resume()},
\code{runtime_idle()}
- \item API and details on \kerneldoc{power/runtime_pm.txt}
+ \item API and details on \kerneldoctext{power/runtime_pm.txt}
\item See also Kevin Hilman's presentation at ELC Europe 2010:
\url{http://elinux.org/images/c/cd/ELC-2010-khilman-Runtime-PM.odp}
\end{itemize}
@@ -175,7 +175,7 @@
\item Platform-independent governors (ladder and menu)
\item Available for x86/ACPI, not supported yet by all ARM cpus.
(look for \code{cpuidle*} files under \kpath{arch/arm/})
- \item See \kerneldoc{cpuidle/} in kernel sources.
+ \item See \kerneldoctext{cpuidle/} in kernel sources.
\end{itemize}
\end{itemize}
\end{frame}
@@ -230,7 +230,7 @@
\item \code{setpolicy()} or \code{target()} to actually perform
the frequency change
\end{itemize}
- \item See \kerneldoc{cpu-freq/} for useful explanations
+ \item See \kerneldoctext{cpu-freq/} for useful explanations
\end{itemize}
\end{frame}
@@ -249,7 +249,7 @@
\end{itemize}
\item According to these requirements, PM QoS allows kernel drivers
to adjust their power management
- \item See \kerneldoc{power/pm_qos_interface.txt}
+ \item See \kerneldoctext{power/pm_qos_interface.txt}
\item Still needs deploying in most drivers
\end{itemize}
\end{frame}
@@ -267,7 +267,7 @@
\item Machine interface for board configuration
\item sysfs interface for user space
\end{itemize}
- \item See \kerneldoc{power/regulator/} in kernel sources.
+ \item See \kerneldoctext{power/regulator/} in kernel sources.
\end{itemize}
\end{frame}
@@ -293,7 +293,7 @@
\begin{frame}
\frametitle{Useful Resources}
\begin{itemize}
- \item \kerneldoc{power/} in the Linux kernel sources.
+ \item \kerneldoctext{power/} in the Linux kernel sources.
\begin{itemize}
\item Will give you many useful details.
\end{itemize}
diff --git a/slides/kernel-resources-references/kernel-resources-references.tex b/slides/kernel-resources-references/kernel-resources-references.tex
index 783fc2e..7aa191f 100644
--- a/slides/kernel-resources-references/kernel-resources-references.tex
+++ b/slides/kernel-resources-references/kernel-resources-references.tex
@@ -82,11 +82,9 @@
\begin{frame}
\frametitle{Useful Online Resources}
\begin{itemize}
- \item Kernel documentation (\kerneldoc{} in kernel sources)
+ \item Kernel documentation
\begin{itemize}
- \item Available on line:
- \url{http://free-electrons.com/kerneldoc/} (with HTML
- documentation extracted from source code)
+ \item \url{https://kernel.org/doc/}
\end{itemize}
\item Linux kernel mailing list FAQ
\begin{itemize}
diff --git a/slides/kernel-serial-drivers-content/kernel-serial-drivers-content.tex b/slides/kernel-serial-drivers-content/kernel-serial-drivers-content.tex
index 50b482b..7d306d2 100644
--- a/slides/kernel-serial-drivers-content/kernel-serial-drivers-content.tex
+++ b/slides/kernel-serial-drivers-content/kernel-serial-drivers-content.tex
@@ -245,7 +245,7 @@ static void atmel_init_port(
\item \code{set_termios()}, change port parameters
\end{itemize}
\item See the detailed description in
- \kerneldoc{serial/driver}
+ \kerneldoctext{serial/driver}
\end{itemize}
\end{frame}
@@ -376,7 +376,7 @@ foo_uart_handle_transmit(port) {
so that even if the system is locked, you can recover it.
\item Through serial port: send a \code{BRK} character, send the
character of the \code{Sysrq} command
- \item See \kerneldoc{sysrq.txt}
+ \item See \kerneldoctext{sysrq.txt}
\end{itemize}
\item In the driver
\begin{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 86c595c..a7601aa 100644
--- a/slides/kernel-source-code-drivers/kernel-source-code-drivers.tex
+++ b/slides/kernel-source-code-drivers/kernel-source-code-drivers.tex
@@ -89,7 +89,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 \kerneldoc{stable_api_nonsense.txt} in kernel sources for
+ \item See \kerneldoctext{stable_api_nonsense.txt} 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
@@ -213,10 +213,10 @@
\item Possibilities for user space device drivers:
\begin{itemize}
\item USB with {\em libusb}, \url{http://www.libusb.org/}
- \item SPI with {\em spidev}, \kerneldoc{spi/spidev}
- \item I2C with {\em i2cdev}, \kerneldoc{i2c/dev-interface}
+ \item SPI with {\em spidev}, \kerneldoctext{spi/spidev}
+ \item I2C with {\em i2cdev}, \kerneldoctext{i2c/dev-interface}
\item Memory-mapped devices with {\em UIO}, including interrupt
- handling, \kerneldoc{DocBook/uio-howto/}
+ handling, \kerneldocbook{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/kernel-source-code-layout/kernel-source-code-layout.tex b/slides/kernel-source-code-layout/kernel-source-code-layout.tex
index 73e7179..1e57e6c 100644
--- a/slides/kernel-source-code-layout/kernel-source-code-layout.tex
+++ b/slides/kernel-source-code-layout/kernel-source-code-layout.tex
@@ -37,10 +37,10 @@
\begin{itemize}
\item \kpath{Documentation/}
\begin{itemize}
- \item Kernel documentation.\\
- Also available on \url{http://free-electrons.com/kerneldoc/}\\
- (result of \code{make htmldocs}, extracting prototypes and comments
- from source code).
+ \item Kernel documentation sources\\
+ Also available on \url{https://www.kernel.org/doc/}\\
+ (includes functions prototypes and comments
+ extracted from source code).
\end{itemize}
\item \kpath{drivers/}
\begin{itemize}
diff --git a/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex b/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
index cf9d693..19fc18f 100644
--- a/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
+++ b/slides/sysdev-block-filesystems/sysdev-block-filesystems.tex
@@ -232,7 +232,7 @@ major minor #blocks name
instances you could have. Examples:\\
\code{mount -t tmpfs varrun /var/run}\\
\code{mount -t tmpfs udev /dev}
- \item See \kerneldoc{filesystems/tmpfs.txt} in kernel sources.
+ \item See \kerneldoctext{filesystems/tmpfs.txt} in kernel sources.
\end{itemize}
\end{frame}
diff --git a/slides/sysdev-linux-intro-cross-compilation/sysdev-linux-intro-cross-compilation.tex b/slides/sysdev-linux-intro-cross-compilation/sysdev-linux-intro-cross-compilation.tex
index adfe2c7..2f03d1c 100644
--- a/slides/sysdev-linux-intro-cross-compilation/sysdev-linux-intro-cross-compilation.tex
+++ b/slides/sysdev-linux-intro-cross-compilation/sysdev-linux-intro-cross-compilation.tex
@@ -221,7 +221,7 @@
\item \code{root=} for the root filesystem (covered later)
\item \code{console=} for the destination of kernel messages
\item Many more exist. The most important ones are documented
- in \kerneldoc{kernel-parameters.txt} in kernel sources.
+ in \kerneldoctext{kernel-parameters.txt} in kernel sources.
\end{itemize}
\item This kernel command line is either
\begin{itemize}
diff --git a/slides/sysdev-realtime/sysdev-realtime.tex b/slides/sysdev-realtime/sysdev-realtime.tex
index a99f648..3203a9b 100644
--- a/slides/sysdev-realtime/sysdev-realtime.tex
+++ b/slides/sysdev-realtime/sysdev-realtime.tex
@@ -877,7 +877,7 @@ timer_delete(timer_t timerid)
and performance issues in the kernel.
\begin{itemize}
- \item Very well documented in \kerneldoc{trace/ftrace.txt}
+ \item Very well documented in \kerneldoctext{trace/ftrace.txt}
\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 5761bd1..7bf2068 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 \kerneldoc{filesystems/proc.txt} in the kernel sources
+ \item \kerneldoctext{filesystems/proc.txt} 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 to
adjust kernel parameters
\begin{itemize}
- \item They are called {\em sysctl}. See \kerneldoc{sysctl/}
+ \item They are called {\em sysctl}. See \kerneldoctext{sysctl/}
in kernel sources.
\item Example\\
\code{echo 3 > /proc/sys/vm/drop_caches}
diff --git a/slides/sysdev-udev/sysdev-udev.tex b/slides/sysdev-udev/sysdev-udev.tex
index 56eb101..facc041 100644
--- a/slides/sysdev-udev/sysdev-udev.tex
+++ b/slides/sysdev-udev/sysdev-udev.tex
@@ -314,7 +314,7 @@ UDEVD_EVENT=1
\begin{center}
\includegraphics[width=\textwidth]{slides/sysdev-udev/firmware-hotplugging.pdf}
\end{center}
- See \kerneldoc{firmware_class/} in the kernel sources for a
+ See \kerneldoctext{firmware_class/} in the kernel sources for a
nice overview
\end{frame}
More information about the training-materials-updates
mailing list