[FE training-materials-updates] Kernel labs: add punctation

Michael Opdenacker michael.opdenacker at free-electrons.com
Thu May 15 09:18:17 CEST 2014


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

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

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

commit 5806a26c9dd7d3a5beb3bef218f0412a13e61289
Author: Luis Ortega <luiorpe1 at gmail.com>
Date:   Tue May 13 14:49:27 2014 +0200

    Kernel labs: add punctation
    
    Signed-off-by: Luis Ortega <luiorpe1 at gmail.com>
    Signed-off-by: Michael Opdenacker <michael.opdenacker at free-electrons.com>


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

5806a26c9dd7d3a5beb3bef218f0412a13e61289
 labs/kernel-board-setup/kernel-board-setup.tex     |    4 ++--
 .../kernel-compiling-and-nfs-booting.tex           |    4 ++--
 labs/kernel-debugging/kernel-debugging.tex         |    4 ++--
 labs/kernel-git/kernel-git.tex                     |   10 +++++-----
 .../kernel-i2c-communication.tex                   |    4 ++--
 .../kernel-i2c-device-model.tex                    |    6 +++---
 .../kernel-i2c-input-interface.tex                 |    4 ++--
 labs/kernel-module-simple/kernel-module-simple.tex |    4 ++--
 .../kernel-serial-interrupt.tex                    |    6 +++---
 labs/kernel-serial-iomem/kernel-serial-iomem.tex   |    8 ++++----
 labs/kernel-serial-output/kernel-serial-output.tex |    4 ++--
 .../kernel-sources-exploring.tex                   |    2 +-
 12 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/labs/kernel-board-setup/kernel-board-setup.tex b/labs/kernel-board-setup/kernel-board-setup.tex
index a55ce4c..809de9e 100644
--- a/labs/kernel-board-setup/kernel-board-setup.tex
+++ b/labs/kernel-board-setup/kernel-board-setup.tex
@@ -3,9 +3,9 @@ with the board and configure the bootloader.}
 
 After this lab, you will be able to:
 \begin{itemize}
-\item Access the board through its serial line
+\item Access the board through its serial line.
 \item Configure the U-boot bootloader and a tftp server
-      on your workstation to download files through tftp
+      on your workstation to download files through tftp.
 \end{itemize}
 
 \section{Getting familiar with the board}
diff --git a/labs/kernel-compiling-and-nfs-booting/kernel-compiling-and-nfs-booting.tex b/labs/kernel-compiling-and-nfs-booting/kernel-compiling-and-nfs-booting.tex
index 8ab931b..717e788 100644
--- a/labs/kernel-compiling-and-nfs-booting/kernel-compiling-and-nfs-booting.tex
+++ b/labs/kernel-compiling-and-nfs-booting/kernel-compiling-and-nfs-booting.tex
@@ -5,10 +5,10 @@ shared by NFS.}
 After this lab, you will be able to:
 \begin{itemize}
 
-\item Cross-compile the Linux kernel for the ARM platform
+\item Cross-compile the Linux kernel for the ARM platform.
 
 \item Boot this kernel on an NFS root filesystem, which is somewhere
-on your development workstation\footnote{NFS root filesystems are
+on your development workstation.\footnote{NFS root filesystems are
 particularly useful to compile modules on your host, and make them
 directly visible on the target. You no longer have to update the root
 filesystem by hand and transfer it to the target (requiring a shutdown
diff --git a/labs/kernel-debugging/kernel-debugging.tex b/labs/kernel-debugging/kernel-debugging.tex
index a3b4762..a36e137 100644
--- a/labs/kernel-debugging/kernel-debugging.tex
+++ b/labs/kernel-debugging/kernel-debugging.tex
@@ -23,7 +23,7 @@ debug documentation in the kernel sources, do the following things:
 
 \begin{itemize}
 
-\item List all available debug messages in the kernel
+\item List all available debug messages in the kernel.
 
 \item Enable all debugging messages of your serial module, and check
   that you indeed see those messages.
@@ -45,7 +45,7 @@ add:
 
 \begin{itemize}
 
-\item A directory called \code{serial} in the \code{debugfs} filesystem
+\item A directory called \code{serial} in the \code{debugfs} filesystem.
 
 \item And file called \code{counter} inside the \code{serial}
   directory of the \code{debugfs} filesystem. This file should allow to see
diff --git a/labs/kernel-git/kernel-git.tex b/labs/kernel-git/kernel-git.tex
index 735fd75..62cfed5 100644
--- a/labs/kernel-git/kernel-git.tex
+++ b/labs/kernel-git/kernel-git.tex
@@ -3,11 +3,11 @@
 After this lab, you will be able to:
 
 \begin{itemize}
-\item Explore the history of a Git repository
-\item Create a branch and use it to make improvements to the Linux kernel sources
-\item Make your first contribution to the official Linux kernel sources
-\item Rework and reorganize the commits done in your branch
-\item Work with a remote tree 
+\item Explore the history of a Git repository.
+\item Create a branch and use it to make improvements to the Linux kernel sources.
+\item Make your first contribution to the official Linux kernel sources.
+\item Rework and reorganize the commits done in your branch.
+\item Work with a remote tree.
 \end{itemize}
 
 \section{Setup}
diff --git a/labs/kernel-i2c-communication/kernel-i2c-communication.tex b/labs/kernel-i2c-communication/kernel-i2c-communication.tex
index 8ea17ad..92e5457 100644
--- a/labs/kernel-i2c-communication/kernel-i2c-communication.tex
+++ b/labs/kernel-i2c-communication/kernel-i2c-communication.tex
@@ -4,8 +4,8 @@ use it to implement communication with the Nunchuk device}
 After this lab, you will be able to:
 
 \begin{itemize}
-\item Declare pinctrl settings
-\item Access I2C device registers through the bus
+\item Declare pinctrl settings.
+\item Access I2C device registers through the bus.
 \end{itemize}
 
 \section{Setup}
diff --git a/labs/kernel-i2c-device-model/kernel-i2c-device-model.tex b/labs/kernel-i2c-device-model/kernel-i2c-device-model.tex
index f45fc45..71b0021 100644
--- a/labs/kernel-i2c-device-model/kernel-i2c-device-model.tex
+++ b/labs/kernel-i2c-device-model/kernel-i2c-device-model.tex
@@ -7,11 +7,11 @@ device, which offers the functionality of an I2C nunchuk.
 After this lab, you will be able to:
 
 \begin{itemize}
-\item Add an I2C device to a device tree
+\item Add an I2C device to a device tree.
 \item Implement basic \code{probe()} and \code{remove()} driver
 functions and make sure that they are called when there is a
 device/driver match.
-\item Find your driver and device in \code{/sys}
+\item Find your driver and device in \code{/sys}.
 \end{itemize}
 
 \section{Setup}
@@ -65,7 +65,7 @@ description for it in the board device tree.
 We will have to do two things:
 
 \begin{enumerate}
-\item Add a node declaring a second I2C bus (\code{i2c1}) 
+\item Add a node declaring a second I2C bus (\code{i2c1}).
 \item Add a child node to this bus, corresponding to the Nunchuk device. 
 \end{enumerate}
 
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 895774d..badd434 100644
--- a/labs/kernel-i2c-input-interface/kernel-i2c-input-interface.tex
+++ b/labs/kernel-i2c-input-interface/kernel-i2c-input-interface.tex
@@ -6,11 +6,11 @@ After this lab, you will be able to:
 \begin{itemize}
 \item Expose device events to userspace through an input interface,
       using the kernel based polling API for input devices
-      (kernel space perspective)
+      (kernel space perspective).
 \item Handle registration and allocation failures in a clean
       way.
 \item Get more familiar with the usage of the input interface
-      (user space perspective)
+      (user space perspective).
 \end{itemize}
 
 \section{Add polled input device support to the kernel}
diff --git a/labs/kernel-module-simple/kernel-module-simple.tex b/labs/kernel-module-simple/kernel-module-simple.tex
index bfe2abf..20e7eba 100644
--- a/labs/kernel-module-simple/kernel-module-simple.tex
+++ b/labs/kernel-module-simple/kernel-module-simple.tex
@@ -6,8 +6,8 @@ After this lab, you will be able to:
 \item Compile and test standalone kernel modules, which code is outside of the main Linux sources.
 \item Write a kernel module with several capabilities, including module parameters.
 \item Access kernel internals from your module.
-\item Setup the environment to compile it
-\item Create a kernel patch
+\item Setup the environment to compile it.
+\item Create a kernel patch.
 \end{itemize}
 
 \section{Setup}
diff --git a/labs/kernel-serial-interrupt/kernel-serial-interrupt.tex b/labs/kernel-serial-interrupt/kernel-serial-interrupt.tex
index 97ef2a8..2265e80 100644
--- a/labs/kernel-serial-interrupt/kernel-serial-interrupt.tex
+++ b/labs/kernel-serial-interrupt/kernel-serial-interrupt.tex
@@ -6,11 +6,11 @@ During this lab, you will:
 
 \begin{itemize}
 \item Register an interrupt handler for the serial controller of the
-  Beaglebone
+  Beaglebone.
 \item Implement the read() operation of the serial port driver to put
-  the process to sleep when no data are available
+  the process to sleep when no data are available.
 \item Implement the interrupt handler to wake-up the sleeping process
-  waiting for received characters
+  waiting for received characters.
 \item Handle communication between the interrupt handler and the
   read() operation.
 \end{itemize}
diff --git a/labs/kernel-serial-iomem/kernel-serial-iomem.tex b/labs/kernel-serial-iomem/kernel-serial-iomem.tex
index a4877f7..83cb53f 100644
--- a/labs/kernel-serial-iomem/kernel-serial-iomem.tex
+++ b/labs/kernel-serial-iomem/kernel-serial-iomem.tex
@@ -8,7 +8,7 @@ the BeagleBone, and to read data from them.
 After this lab, you will be able to:
 
 \begin{itemize}
-\item Add UART devices to the board device tree
+\item Add UART devices to the board device tree.
 \item Access I/O registers to control the device and
       send first characters to it.
 \end{itemize}
@@ -39,9 +39,9 @@ instructor, connect your PC to UART2. The wire colors are the same
 as for the cable that you're using for the console:
 
 \begin{itemize}
-\item The blue wire should be connected \code{GND} 
-\item The red wire (\code{TX}) should be connected to the board's \code{RX} pin
-\item The green wire (\code{RX}) should be connected to the board's \code{TX} pin
+\item The blue wire should be connected \code{GND}.
+\item The red wire (\code{TX}) should be connected to the board's \code{RX} pin.
+\item The green wire (\code{RX}) should be connected to the board's \code{TX} pin.
 \end{itemize}
 
 You can (or even should) show your connections to the instructor
diff --git a/labs/kernel-serial-output/kernel-serial-output.tex b/labs/kernel-serial-output/kernel-serial-output.tex
index 56bdbae..eb8fd99 100644
--- a/labs/kernel-serial-output/kernel-serial-output.tex
+++ b/labs/kernel-serial-output/kernel-serial-output.tex
@@ -61,7 +61,7 @@ to work, you can now initialize the \code{miscdevice} structure
 for each found device:
 
 \begin{itemize}
-\item To get an automatically assigned minor number 
+\item To get an automatically assigned minor number.
 \item To specify a name for the device file in {\em devtmpfs}. We
       propose to use
       \code{kasprintf(GFP_KERNEL, "feserial-\%x", res->start)}.
@@ -119,7 +119,7 @@ Now, add code to your write function, to copy user data to the serial
 port, writing characters one by one.
 
 The first thing to do is to retrieve the \code{feserial_dev} structure
-from the \code{miscdevice} structure, itself accessible through the 
+from the \code{miscdevice} structure itself, accessible through the
 \code{private_data} field of the open file structure (\code{file}).
 
 At the time we registered our {\em misc} device, we didn't keep any
diff --git a/labs/kernel-sources-exploring/kernel-sources-exploring.tex b/labs/kernel-sources-exploring/kernel-sources-exploring.tex
index 02dcb2f..48fe4ee 100644
--- a/labs/kernel-sources-exploring/kernel-sources-exploring.tex
+++ b/labs/kernel-sources-exploring/kernel-sources-exploring.tex
@@ -46,7 +46,7 @@ implements a given function. So, it is useful to be familiar with
 exploring the kernel sources.
 
 \begin{enumerate}
-\item Find the Linux logo image in the sources
+\item Find the Linux logo image in the sources.
       \footnote{Look for files in \code{logo} in their name. It's an 
       opportunity to practise with the \code{find} command.}
 \item Find who the maintainer of the MVNETA network driver is.



More information about the training-materials-updates mailing list