[bootlin/training-materials updates] master: Kernel slides: harmonize the use of capital letters in titles (9d27df9f)

Miquel Raynal miquel.raynal at bootlin.com
Wed Mar 10 19:43:29 CET 2021


Repository : https://github.com/bootlin/training-materials
On branch  : master
Link       : https://github.com/bootlin/training-materials/commit/9d27df9f5bc8c9d9be2af2438ed7eb1bc499c4a1

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

commit 9d27df9f5bc8c9d9be2af2438ed7eb1bc499c4a1
Author: Miquel Raynal <miquel.raynal at bootlin.com>
Date:   Wed Mar 10 19:15:43 2021 +0100

    Kernel slides: harmonize the use of capital letters in titles
    
    Yes, it bothers me a lot.
    
    Signed-off-by: Miquel Raynal <miquel.raynal at bootlin.com>


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

9d27df9f5bc8c9d9be2af2438ed7eb1bc499c4a1
 .../kernel-driver-development-concurrency.tex      | 20 ++++++++--------
 .../kernel-driver-development-general-apis.tex     |  4 ++--
 .../kernel-driver-development-interrupts.tex       |  4 ++--
 ...el-driver-development-lab-character-drivers.tex |  2 +-
 .../kernel-driver-development-lab-io-memory.tex    |  2 +-
 .../kernel-driver-development-lab-modules.tex      |  2 +-
 .../kernel-driver-development-memory.tex           | 24 +++++++++----------
 .../kernel-driver-development-mmap.tex             |  8 +++----
 .../kernel-driver-development-modules.tex          | 28 +++++++++++-----------
 .../kernel-driver-development-sleeping.tex         |  2 +-
 10 files changed, 48 insertions(+), 48 deletions(-)

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 8c4fee4c..79add433 100644
--- a/slides/kernel-driver-development-concurrency/kernel-driver-development-concurrency.tex
+++ b/slides/kernel-driver-development-concurrency/kernel-driver-development-concurrency.tex
@@ -57,7 +57,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Locking and Unlocking Mutexes 1/2}
+  \frametitle{Locking and unlocking mutexes 1/2}
   \begin{itemize}
   \item \mint{c}+void mutex_lock(struct mutex *lock);+
     \begin{itemize}
@@ -79,7 +79,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Locking and Unlocking Mutexes 2/2}
+  \frametitle{Locking and unlocking mutexes 2/2}
   \begin{itemize}
   \item \mint{c}+int mutex_trylock(struct mutex *lock);+
     \begin{itemize}
@@ -116,7 +116,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Initializing Spinlocks}
+  \frametitle{Initializing spinlocks}
   \begin{itemize}
   \item Statically (unusual)
     \begin{itemize}
@@ -130,7 +130,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Using Spinlocks 1/3}
+  \frametitle{Using spinlocks 1/3}
   Several variants, depending on where the spinlock is called:
   \begin{itemize}
   \item \mint{c}+void spin_lock(spinlock_t *lock);+
@@ -147,7 +147,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Using Spinlocks 2/3}
+  \frametitle{Using spinlocks 2/3}
   \begin{itemize}
   \item \mint{c}+void spin_lock_irqsave(spinlock_t *lock, unsigned long flags);+
   \item \mint{c}+void spin_unlock_irqrestore(spinlock_t *lock, unsigned long flags);+
@@ -163,7 +163,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Using Spinlocks 3/3}
+  \frametitle{Using spinlocks 3/3}
   \begin{itemize}
   \item \mint{c}+void spin_lock_bh(spinlock_t *lock);+
   \item \mint{c}+void spin_unlock_bh(spinlock_t *lock);+
@@ -248,7 +248,7 @@ static unsigned int ulite_tx_empty
 \end{frame}
 
 \begin{frame}
-  \frametitle{Alternatives to Locking}
+  \frametitle{Alternatives to locking}
   As we have just seen, locking can have a strong negative
   impact on system performance. In some situations, you could do
   without it.
@@ -262,7 +262,7 @@ static unsigned int ulite_tx_empty
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Atomic Variables 1/2}
+  \frametitle{Atomic variables 1/2}
   \begin{itemize}
   \item Useful when the shared resource is an integer value
   \item Even an instruction like \code{n++} is not guaranteed to be
@@ -294,7 +294,7 @@ static unsigned int ulite_tx_empty
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Atomic Variables 2/2}
+  \frametitle{Atomic variables 2/2}
   \begin{itemize}
   \item Similar functions testing the result:
     \begin{itemize}
@@ -313,7 +313,7 @@ static unsigned int ulite_tx_empty
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Atomic Bit Operations}
+  \frametitle{Atomic bit operations}
   \begin{itemize}
   \item Supply very fast, atomic operations
   \item On most platforms, apply to an \code{unsigned long *} type.
diff --git a/slides/kernel-driver-development-general-apis/kernel-driver-development-general-apis.tex b/slides/kernel-driver-development-general-apis/kernel-driver-development-general-apis.tex
index b7af4994..ece9dbe1 100644
--- a/slides/kernel-driver-development-general-apis/kernel-driver-development-general-apis.tex
+++ b/slides/kernel-driver-development-general-apis/kernel-driver-development-general-apis.tex
@@ -49,7 +49,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Linked Lists Examples 1/2}
+  \frametitle{Linked lists examples 1/2}
   From \kfile{include/soc/at91/atmel_tcb.h}
 \begin{minted}{c}
 /*
@@ -65,7 +65,7 @@ struct atmel_tc
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Linked Lists Examples 2/2}
+  \frametitle{Linked lists examples 2/2}
   From \kfile{drivers/misc/atmel_tclib.c}
 \begin{minted}[fontsize=\scriptsize]{c}
 /* Define the global list */
diff --git a/slides/kernel-driver-development-interrupts/kernel-driver-development-interrupts.tex b/slides/kernel-driver-development-interrupts/kernel-driver-development-interrupts.tex
index c7bcdcc7..f25a209d 100644
--- a/slides/kernel-driver-development-interrupts/kernel-driver-development-interrupts.tex
+++ b/slides/kernel-driver-development-interrupts/kernel-driver-development-interrupts.tex
@@ -257,7 +257,7 @@ int devm_request_threaded_irq(
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Tasklet Example: drivers/crypto/atmel-sha.c 1/2}
+  \frametitle{Tasklet example: drivers/crypto/atmel-sha.c 1/2}
 \begin{minted}[fontsize=\scriptsize]{c}
 /* The tasklet function */
 static void atmel_sha_done_task(unsigned long data)
@@ -284,7 +284,7 @@ static int atmel_sha_probe(struct platform_device *pdev)
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Tasklet Example: drivers/crypto/atmel-sha.c 2/2}
+  \frametitle{Tasklet example: drivers/crypto/atmel-sha.c 2/2}
 \begin{minted}[fontsize=\scriptsize]{c}
 /* Remove function: removing the tasklet */
 static int atmel_sha_remove(struct platform_device *pdev)
diff --git a/slides/kernel-driver-development-lab-character-drivers/kernel-driver-development-lab-character-drivers.tex b/slides/kernel-driver-development-lab-character-drivers/kernel-driver-development-lab-character-drivers.tex
index e5867576..749f824e 100644
--- a/slides/kernel-driver-development-lab-character-drivers/kernel-driver-development-lab-character-drivers.tex
+++ b/slides/kernel-driver-development-lab-character-drivers/kernel-driver-development-lab-character-drivers.tex
@@ -1,5 +1,5 @@
 \setuplabframe
-{Character Drivers}
+{Character drivers}
 {
   \begin{itemize}
   \item Writing a simple character driver, to write data to the serial
diff --git a/slides/kernel-driver-development-lab-io-memory/kernel-driver-development-lab-io-memory.tex b/slides/kernel-driver-development-lab-io-memory/kernel-driver-development-lab-io-memory.tex
index 5c5d82cb..6302ef84 100644
--- a/slides/kernel-driver-development-lab-io-memory/kernel-driver-development-lab-io-memory.tex
+++ b/slides/kernel-driver-development-lab-io-memory/kernel-driver-development-lab-io-memory.tex
@@ -1,5 +1,5 @@
 \setuplabframe
-{I/O Memory and Ports}
+{I/O memory and ports}
 {
 \begin{itemize}
 \item Add UART devices to the board device tree
diff --git a/slides/kernel-driver-development-lab-modules/kernel-driver-development-lab-modules.tex b/slides/kernel-driver-development-lab-modules/kernel-driver-development-lab-modules.tex
index 4d376a55..cadb3f8f 100644
--- a/slides/kernel-driver-development-lab-modules/kernel-driver-development-lab-modules.tex
+++ b/slides/kernel-driver-development-lab-modules/kernel-driver-development-lab-modules.tex
@@ -1,5 +1,5 @@
 \setuplabframe
-{Writing Modules}
+{Writing modules}
 {
   \begin{itemize}
   \item Create, compile and load your first module
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 78b08a04..bd53fde0 100644
--- a/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
+++ b/slides/kernel-driver-development-memory/kernel-driver-development-memory.tex
@@ -1,14 +1,14 @@
 \section{Memory Management}
 
 \begin{frame}
-  \frametitle{Physical and Virtual Memory}
+  \frametitle{Physical and virtual memory}
   \begin{center}
     \includegraphics[height=0.8\textheight]{slides/kernel-driver-development-memory/mmu.pdf}
   \end{center}
 \end{frame}
 
 \begin{frame}
-  \frametitle{Virtual Memory Organization}
+  \frametitle{Virtual memory organization}
   \begin{columns}
     \column{0.3\textwidth}
     \includegraphics[height=0.8\textheight]{slides/kernel-driver-development-memory/memory-organization.pdf}
@@ -91,14 +91,14 @@
 \end{frame}
 
 \begin{frame}
-  \frametitle{Allocators in the Kernel}
+  \frametitle{Allocators in the kernel}
   \begin{center}
     \includegraphics[height=0.8\textheight]{slides/kernel-driver-development-memory/allocators.pdf}
   \end{center}
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Page Allocator}
+  \frametitle{Page allocator}
   \begin{itemize}
   \item Appropriate for medium-size allocations
   \item A page is usually 4K, but can be made greater in some
@@ -123,7 +123,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Page Allocator API: Get free pages}
+  \frametitle{Page allocator API: get free pages}
   \begin{itemize}
   \item \mint{c}+unsigned long get_zeroed_page(int flags)+
     \begin{itemize}
@@ -146,7 +146,7 @@
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Page Allocator API: Free Pages}
+  \frametitle{Page allocator API: free pages}
   \begin{itemize}
   \item \mint{c}+void free_page(unsigned long addr)+
     \begin{itemize}
@@ -162,7 +162,7 @@
 \end{frame}
 
 \begin{frame}
-  \frametitle{Page Allocator Flags}
+  \frametitle{Page allocator flags}
   The most common ones are:
   \begin{itemize}
   \item \ksym{GFP_KERNEL}
@@ -189,7 +189,7 @@
 \end{frame}
 
 \begin{frame}
-  \frametitle{SLAB Allocator 1/2}
+  \frametitle{SLAB allocator 1/2}
   \begin{itemize}
   \item The SLAB allocator allows to create {\em caches}, which contain a
     set of objects of the same size. In English, {\em slab} means {\em tile}.
@@ -209,14 +209,14 @@
 \end{frame}
 
 \begin{frame}
-  \frametitle{SLAB Allocator 2/2}
+  \frametitle{SLAB allocator 2/2}
   \begin{center}
     \includegraphics[height=0.8\textheight]{slides/kernel-driver-development-memory/slab-allocator.pdf}
   \end{center}
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Different SLAB Allocators}
+  \frametitle{Different SLAB allocators}
   \small
   There are three different, but API compatible, implementations of
   a SLAB allocator in the Linux kernel. A particular implementation
@@ -240,7 +240,7 @@
 \end{frame}
 
 \begin{frame}
-  \frametitle{kmalloc Allocator}
+  \frametitle{kmalloc allocator}
   \begin{itemize}
   \item The kmalloc allocator is the general purpose memory allocator
     in the Linux kernel
@@ -327,7 +327,7 @@ kfree(work);
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{vmalloc Allocator}
+  \frametitle{vmalloc allocator}
   \begin{itemize}
   \item The \kfunc{vmalloc} allocator can be used to obtain
     memory zones that are contiguous in the virtual addressing space,
diff --git a/slides/kernel-driver-development-mmap/kernel-driver-development-mmap.tex b/slides/kernel-driver-development-mmap/kernel-driver-development-mmap.tex
index b70cda5f..cb4e06d3 100644
--- a/slides/kernel-driver-development-mmap/kernel-driver-development-mmap.tex
+++ b/slides/kernel-driver-development-mmap/kernel-driver-development-mmap.tex
@@ -39,14 +39,14 @@
 \end{frame}
 
 \begin{frame}
-  \frametitle{mmap Overview}
+  \frametitle{mmap overview}
   \begin{center}
     \includegraphics[height=0.8\textheight]{slides/kernel-driver-development-mmap/mmap-overview.pdf}
   \end{center}
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{How to Implement mmap - User Space}
+  \frametitle{How to Implement mmap - User space}
   \begin{itemize}
   \item Open the device file
   \item Call the \code{mmap} system call (see \code{man mmap} for
@@ -66,7 +66,7 @@ void * mmap(
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{How to Implement mmap - Kernel Space}
+  \frametitle{How to Implement mmap - Kernel space}
   \begin{itemize}
   \item Character driver: implement an \code{mmap} file operation and add it
     to the driver file operations:
@@ -153,7 +153,7 @@ static int acme_mmap
 \end{frame}
 
 \begin{frame}
-  \frametitle{mmap Summary}
+  \frametitle{mmap summary}
   \begin{itemize}
   \item The device driver is loaded. It defines an \code{mmap} file
     operation.
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 007b8b19..8fea9f4b 100644
--- a/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
+++ b/slides/kernel-driver-development-modules/kernel-driver-development-modules.tex
@@ -1,7 +1,7 @@
-\section{Developing Kernel Modules}
+\section{Developing kernel modules}
 
 \begin{frame}[fragile]
-  \frametitle{Hello Module 1/2}
+  \frametitle{Hello module 1/2}
 \begin{minted}[fontsize=\scriptsize]{c}
 // SPDX-License-Identifier: GPL-2.0
 /* hello.c */
@@ -29,7 +29,7 @@ MODULE_AUTHOR("William Shakespeare");
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Hello Module 2/2}
+  \frametitle{Hello module 2/2}
 \begin{itemize}
 \item Code marked as \ksym{__init}:
   \begin{itemize}
@@ -52,7 +52,7 @@ MODULE_AUTHOR("William Shakespeare");
 \end{frame}
 
 \begin{frame}
-  \frametitle{Hello Module Explanations}
+  \frametitle{Hello module explanations}
   \begin{itemize}
   \item Headers specific to the Linux kernel: \code{linux/xxx.h}
     \begin{itemize}
@@ -78,7 +78,7 @@ MODULE_AUTHOR("William Shakespeare");
 \end{frame}
 
 \begin{frame}
-  \frametitle{Symbols Exported to Modules 1/2}
+  \frametitle{Symbols exported to modules 1/2}
   \begin{itemize}
   \item From a kernel module, only a limited number of kernel
     functions can be called
@@ -106,7 +106,7 @@ MODULE_AUTHOR("William Shakespeare");
 \end{frame}
 
 \begin{frame}
-  \frametitle{Module License}
+  \frametitle{Module license}
   \begin{itemize}
   \item Several usages
     \begin{itemize}
@@ -136,7 +136,7 @@ MODULE_AUTHOR("William Shakespeare");
 \end{frame}
 
 \begin{frame}
-  \frametitle{Compiling a Module}
+  \frametitle{Compiling a module}
   Two solutions
   \begin{itemize}
   \item \emph{Out of tree}
@@ -159,7 +159,7 @@ MODULE_AUTHOR("William Shakespeare");
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Compiling an out-of-tree Module 1/2}
+  \frametitle{Compiling an out-of-tree module 1/2}
   \begin{itemize}
   \item The below \code{Makefile} should be reusable for any single-file
     out-of-tree Linux module
@@ -187,7 +187,7 @@ endif
 \end{frame}
 
 \begin{frame}
-  \frametitle{Compiling an out-of-tree Module 2/2}
+  \frametitle{Compiling an out-of-tree module 2/2}
   \begin{center}
     \includegraphics[height=0.4\textheight]{slides/kernel-driver-development-modules/out-of-tree.pdf}
   \end{center}
@@ -203,7 +203,7 @@ endif
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Modules and Kernel Version}
+  \frametitle{Modules and kernel version}
   \begin{itemize}
   \item To be compiled, a kernel module needs access to {\em kernel
     headers}, containing the definitions of functions, types and
@@ -231,7 +231,7 @@ endif
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{New Driver in Kernel Sources 1/2}
+  \frametitle{New driver in kernel sources 1/2}
   \begin{itemize}
   \item To add a new driver to the kernel sources:
     \begin{itemize}
@@ -260,7 +260,7 @@ config USB_SERIAL_NAVMAN
 \end{frame}
 
 \begin{frame}
-  \frametitle{New Driver in Kernel Sources 2/2}
+  \frametitle{New driver in kernel sources 2/2}
   \begin{itemize}
   \item Add a line in the \code{Makefile} file based on the
 \code{Kconfig} setting:
@@ -279,7 +279,7 @@ config USB_SERIAL_NAVMAN
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Hello Module with Parameters 1/2}
+  \frametitle{Hello module with parameters 1/2}
 \begin{minted}[fontsize=\small]{c}
 // SPDX-License-Identifier: GPL-2.0
 /* hello_param.c */
@@ -299,7 +299,7 @@ MODULE_PARM_DESC(howmany, "Number of greetings");
 \end{frame}
 
 \begin{frame}[fragile]
-  \frametitle{Hello Module with Parameters 2/2}
+  \frametitle{Hello module with parameters 2/2}
 \begin{minted}[fontsize=\footnotesize]{c}
 static int __init hello_init(void)
 {
diff --git a/slides/kernel-driver-development-sleeping/kernel-driver-development-sleeping.tex b/slides/kernel-driver-development-sleeping/kernel-driver-development-sleeping.tex
index cfa08387..312ddf83 100644
--- a/slides/kernel-driver-development-sleeping/kernel-driver-development-sleeping.tex
+++ b/slides/kernel-driver-development-sleeping/kernel-driver-development-sleeping.tex
@@ -86,7 +86,7 @@ int wait_event_interruptible_timeout(queue,
 \end{frame}
 
 \begin{frame}[fragile]
-\frametitle{How to Sleep - Example}
+\frametitle{How to sleep - Example}
 \begin{minted}{c}
 sig = wait_event_interruptible(ibmvtpm->wq,
                                !ibmvtpm->tpm_processing_cmd);




More information about the training-materials-updates mailing list