[FE training-materials-updates] Slides: add missing kernel documentation links

Michael Opdenacker michael.opdenacker at free-electrons.com
Fri Nov 29 09:42:56 CET 2013


Repository : git://git.free-electrons.com/training-materials.git

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

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

commit 28a9a5c0aada28ff5b83e48b88ca17a5ab102c7e
Author: Michael Opdenacker <michael.opdenacker at free-electrons.com>
Date:   Fri Nov 29 09:42:14 2013 +0100

    Slides: add missing kernel documentation links
    
    Signed-off-by: Michael Opdenacker <michael.opdenacker at free-electrons.com>


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

28a9a5c0aada28ff5b83e48b88ca17a5ab102c7e
 common/beamerthemeFreeElectrons.sty                |    3 +--
 .../kernel-i2c-input-interface.tex                 |    2 +-
 slides/kernel-input/kernel-input.tex               |    2 +-
 slides/kernel-pinmuxing/kernel-pinmuxing.tex       |    6 +++---
 .../kernel-resources-references.tex                |    2 +-
 5 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/common/beamerthemeFreeElectrons.sty b/common/beamerthemeFreeElectrons.sty
index 7bc8665..1ac2d60 100644
--- a/common/beamerthemeFreeElectrons.sty
+++ b/common/beamerthemeFreeElectrons.sty
@@ -30,8 +30,7 @@
 \newcommand\ksym[1]{\href{http://lxr.free-electrons.com/ident?i=#1}{\code{#1}}}
 \newcommand\kstruct[1]{\href{http://lxr.free-electrons.com/ident?i=#1}{\code{struct #1}}}
 \newcommand\kpath[1]{\href{http://lxr.free-electrons.com/source/#1}{\code{#1}}}
-\newcommand\kerneldoc[1]{
-  {\href{http://free-electrons.com/kerneldoc/latest/#1}{\code{Documentation/#1}}}
+\newcommand\kerneldoc[1]{{\href{http://free-electrons.com/kerneldoc/latest/#1}{\code{Documentation/#1}}}
 }
 
 \usepackage{listings}
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 5d5e882..ccc5687 100644
--- a/labs/kernel-i2c-input-interface/kernel-i2c-input-interface.tex
+++ b/labs/kernel-i2c-input-interface/kernel-i2c-input-interface.tex
@@ -70,7 +70,7 @@ To implement this correctly without duplicating or creating ugly code,
 it's recommended to use \code{goto} statements.
 
 See {\em Chapter 7: Centralized exiting of functions} in
-\code{Documentation/CodingStyle} for useful guidelines and an example.
+\kerneldoc{CodingStyle} for useful guidelines and an example.
 Implement this in your driver. 
 
 \section{Implement the remove() function}
diff --git a/slides/kernel-input/kernel-input.tex b/slides/kernel-input/kernel-input.tex
index 0e5700a..b7298d5 100644
--- a/slides/kernel-input/kernel-input.tex
+++ b/slides/kernel-input/kernel-input.tex
@@ -115,7 +115,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 \code{Documentation/input/event-codes.txt}
+    \item The event types are documented in \kerneldoc{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 927aea4..962528a 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
-      \code{Documentation/devicetree/bindings/pinctrl}.
+      \kerneldoc{devicetree/bindings/pinctrl}.
     \end{itemize}
   \end{itemize}
 \end{frame}
@@ -69,7 +69,7 @@ i2c at 11000 {
 };
 \end{minted}
 \item See
-  \code{Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt}
+  \kerneldoc{devicetree/bindings/pinctrl/pinctrl-bindings.txt}
   for details.
 \end{itemize}
 \end{frame}
@@ -90,7 +90,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
-    \code{Documentation/devicetree/bindings/pinctrl} for the DT
+    \kerneldoc{devicetree/bindings/pinctrl} for the DT
     bindings documentations.
   \end{itemize}
 \end{frame}
diff --git a/slides/kernel-resources-references/kernel-resources-references.tex b/slides/kernel-resources-references/kernel-resources-references.tex
index cd98031..e15be24 100644
--- a/slides/kernel-resources-references/kernel-resources-references.tex
+++ b/slides/kernel-resources-references/kernel-resources-references.tex
@@ -113,7 +113,7 @@
 \begin{frame}
   \frametitle{Useful Online Resources}
   \begin{itemize}
-  \item Kernel documentation (\code{Documentation/} in kernel sources)
+  \item Kernel documentation (\kerneldoc{} in kernel sources)
     \begin{itemize}
     \item Available on line:
       \url{http://free-electrons.com/kerneldoc/} (with HTML



More information about the training-materials-updates mailing list