[FE training-materials-updates] Fix broken documentation URLs

Michael Opdenacker michael.opdenacker at free-electrons.com
Fri Mar 10 11:41:37 CET 2017


Repository : git://git.free-electrons.com/training-materials.git
On branch  : master
Link       : http://git.free-electrons.com/training-materials/commit/?id=f49abddfb2ab9ab426262503ab97a87eb35d7106

>---------------------------------------------------------------

commit f49abddfb2ab9ab426262503ab97a87eb35d7106
Author: Michael Opdenacker <michael.opdenacker at free-electrons.com>
Date:   Fri Mar 10 11:41:37 2017 +0100

    Fix broken documentation URLs
    
    - More in an upcoming commit!
    
    Signed-off-by: Michael Opdenacker <michael.opdenacker at free-electrons.com>


>---------------------------------------------------------------

f49abddfb2ab9ab426262503ab97a87eb35d7106
 common/beamerthemeFreeElectrons.sty                                 | 1 +
 slides/first-slides/first-slides.tex                                | 2 +-
 .../kernel-driver-development-debugging.tex                         | 6 +++---
 .../kernel-driver-development-memory.tex                            | 4 ++--
 slides/kernel-frameworks/kernel-frameworks.tex                      | 2 +-
 slides/kernel-source-code-drivers/kernel-source-code-drivers.tex    | 2 +-
 .../sysdev-linux-intro-cross-compilation.tex                        | 2 +-
 7 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/common/beamerthemeFreeElectrons.sty b/common/beamerthemeFreeElectrons.sty
index de9ad02..67f8fc1 100644
--- a/common/beamerthemeFreeElectrons.sty
+++ b/common/beamerthemeFreeElectrons.sty
@@ -40,6 +40,7 @@
 \newcommand\ksubarch[1]{\href{http://lxr.free-electrons.com/source/arch/#1}{\code{#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}}}
+\newcommand\kerneldochtml[1]{\href{https://www.kernel.org/doc/html/latest/#1.html}{\code{#1}}}
 
 \usepackage{listings}
 \usepackage{environ}
diff --git a/slides/first-slides/first-slides.tex b/slides/first-slides/first-slides.tex
index b6886b3..64ab604 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:\\
-	  \kerneldoctext{kmemcheck.txt}
+	  \kerneldochtml{dev-tools/kmemcheck}
     \item Links to kernel source files and directories:\\
 	  \kpath{drivers/input} \\
 	  \kpath{include/linux/fb.h}
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 26ff17c..a83286f 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 \kerneldoctext{dynamic-debug-howto.txt} for details
+    \item See \kerneldochtml{admin-guide/dynamic-debug-howto} for details
     \item Very powerful feature to only get the debug messages you're
       interested in.
     \end{itemize}
@@ -88,7 +88,7 @@ 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
-      \kerneldoctext{kernel-parameters.txt} for details.
+      \kerneldochtml{admin-guide/kernel-parameters} 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
@@ -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 \kerneldoctext{sysrq.txt}
+  \item Detailed in \kerneldochtml{admin-guide/sysrq}
   \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 8c34786..5f1a61c 100644
--- a/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
+++ b/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
@@ -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 \kerneldoctext{kmemcheck.txt} for details.
+    \item See \kerneldochtml{dev-tools/kmemcheck} 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 \kerneldoctext{kmemleak.txt} for details.
+    \item See \kerneldochtml{dev-tools/kmemleak} for details.
     \end{itemize}
   \end{itemize}
   Both have a significant overhead. Only use them in development!
diff --git a/slides/kernel-frameworks/kernel-frameworks.tex b/slides/kernel-frameworks/kernel-frameworks.tex
index ad536ba..c3f12f2 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 \kerneldoctext{devices.txt}.
+  \item They are defined in \kerneldochtml{admin-guide/devices}.
   \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 a7601aa..cf7becb 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 \kerneldoctext{stable_api_nonsense.txt} in kernel sources for
+  \item See \kerneldochtml{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
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 2f03d1c..de3be21 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 \kerneldoctext{kernel-parameters.txt} in kernel sources.
+          in \kerneldochtml{admin-guide/kernel-parameters} in kernel sources.
     \end{itemize}
   \item This kernel command line is either
     \begin{itemize}




More information about the training-materials-updates mailing list