[bootlin/training-materials updates] master: Practical labs: eliminate "<user>" for instructions or improve explanations (af31134d)

Michael Opdenacker michael.opdenacker at bootlin.com
Tue Sep 10 17:16:32 CEST 2019 

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

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

commit af31134df40108dd20728f80de508502f0867dc3
Author: Michael Opdenacker <michael.opdenacker at bootlin.com>
Date:   Tue Sep 10 17:16:32 2019 +0200

    Practical labs: eliminate "<user>" for instructions or improve explanations
    
    - Too many people copy this string without replacing it
      with their actual user name.
    
      Try to get their attention on this by more explicit
      instructions.
    
    Signed-off-by: Michael Opdenacker <michael.opdenacker at bootlin.com>


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

af31134df40108dd20728f80de508502f0867dc3
 common/boneblack-sdcard-preparation.tex                               | 4 ++--
 labs/boot-time-build-bootloader/boot-time-build-bootloader.tex        | 4 ++--
 labs/boot-time-toolchain/boot-time-toolchain.tex                      | 1 +
 labs/buildroot-basic/buildroot-basic.tex                              | 2 +-
 labs/buildroot-rootfs/buildroot-rootfs.tex                            | 4 ++--
 .../kernel-compiling-and-nfs-booting.tex                              | 4 ++++
 labs/sysdev-application-debugging/sysdev-application-debugging.tex    | 2 ++
 labs/sysdev-buildroot/sysdev-buildroot.tex                            | 1 +
 labs/sysdev-tinysystem/sysdev-tinysystem.tex                          | 4 ++++
 slides/sysdev-busybox/sysdev-busybox.tex                              | 2 +-
 10 files changed, 20 insertions(+), 8 deletions(-)

diff --git a/common/boneblack-sdcard-preparation.tex b/common/boneblack-sdcard-preparation.tex
index bd901105..d3202827 100644
--- a/common/boneblack-sdcard-preparation.tex
+++ b/common/boneblack-sdcard-preparation.tex
@@ -78,5 +78,5 @@ To format your SD card, do the following steps:
 \end{enumerate}
 
 Remove the SD card and insert it again, the two partitions should be
-mounted automatically, in \code{/media/<user>/boot} and
-\code{/media/<user>/rootfs}.
+mounted automatically, in \code{/media/$USER/boot} and
+\code{/media/$USER/rootfs}.
diff --git a/labs/boot-time-build-bootloader/boot-time-build-bootloader.tex b/labs/boot-time-build-bootloader/boot-time-build-bootloader.tex
index 7e9ed7df..efa431fb 100644
--- a/labs/boot-time-build-bootloader/boot-time-build-bootloader.tex
+++ b/labs/boot-time-build-bootloader/boot-time-build-bootloader.tex
@@ -19,7 +19,7 @@ If the previous Buildroot lab is already over, we can use the
 toolchain it built to compile our bootloader and kernel:
 
 \begin{verbatim}
-export PATH=/home/<user>/boot-time-labs/rootfs/buildroot/output/host/bin:$PATH
+export PATH=$HOME/boot-time-labs/rootfs/buildroot/output/host/bin:$PATH
 export CROSS_COMPILE=arm-buildroot-linux-uclibcgnueabihf-
 \end{verbatim}
 
@@ -36,7 +36,7 @@ such settings permanent by adding the below lines at the end of your
 \code{~/.bashrc} file:
 
 \begin{verbatim}
-export PATH=/home/<user>/boot-time-labs/rootfs/buildroot/output/host/bin:$PATH
+export PATH=$HOME/boot-time-labs/rootfs/buildroot/output/host/bin:$PATH
 export CROSS_COMPILE=arm-buildroot-linux-uclibcgnueabihf-
 \end{verbatim}
 
diff --git a/labs/boot-time-toolchain/boot-time-toolchain.tex b/labs/boot-time-toolchain/boot-time-toolchain.tex
index 98f6a069..bd847206 100644
--- a/labs/boot-time-toolchain/boot-time-toolchain.tex
+++ b/labs/boot-time-toolchain/boot-time-toolchain.tex
@@ -182,6 +182,7 @@ In the \code{Toolchain} menu:
 \item Set \code{Toolchain origin} to \code{Pre-installed toolchain}
 \item Set \code{Toolchain path} to\\
       \code{/home/<user>/boot-time-labs/rootfs/arm-buildroot-linux-uclibcgnueabihf_sdk-buildroot}
+      (replace \code{<user>} by your actual user name)
 \item Set \code{External toolchain kernel headers series} to \code{4.19.x}
 \item Set \code{External toolchain gcc version} to \code{7.x}
 \item Disable \code{Toolchain has threads debugging support?}
diff --git a/labs/buildroot-basic/buildroot-basic.tex b/labs/buildroot-basic/buildroot-basic.tex
index 6ae16b68..b724b393 100644
--- a/labs/buildroot-basic/buildroot-basic.tex
+++ b/labs/buildroot-basic/buildroot-basic.tex
@@ -337,7 +337,7 @@ on the SD card:
 
 \item Extract the \code{rootfs.tar} file to the \code{rootfs}
   partition of the SD card, using:\\
-  \code{sudo tar -C /media/<user>/rootfs/ -xf output/images/rootfs.tar}.
+  \code{sudo tar -C /media/$USER/rootfs/ -xf output/images/rootfs.tar}.
 
 \item Create a file named \code{uEnv.txt} in the \code{boot}
   partition. This file should contain the following lines:
diff --git a/labs/buildroot-rootfs/buildroot-rootfs.tex b/labs/buildroot-rootfs/buildroot-rootfs.tex
index 634edbec..bebb398b 100644
--- a/labs/buildroot-rootfs/buildroot-rootfs.tex
+++ b/labs/buildroot-rootfs/buildroot-rootfs.tex
@@ -162,8 +162,8 @@ Re-extract the root filesystem tarball in the \code{rootfs} partition
 of the SD card. Don't forget to replace the entire root filesystem:
 
 \begin{verbatim}
-rm -rf /media/<user>/rootfs/*
-sudo tar -C /media/<user>/rootfs/ -xf output/images/rootfs.tar
+rm -rf /media/$USER/rootfs/*
+sudo tar -C /media/$USER/rootfs/ -xf output/images/rootfs.tar
 \end{verbatim}
 
 Now, boot the new system on the BeagleBone Black. You should see a
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 4b369f25..e6be9b86 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
@@ -116,6 +116,8 @@ of your board will be \code{192.168.0.100}:
 \end{verbatim}
 \normalsize
 
+Of course, replace \code{<user>} by your actual user name.
+
 Make sure that the path and the options are on the same line.
 Also make sure that there is no space between the IP address and the NFS
 options, otherwise default options will be used for this IP address,
@@ -146,6 +148,8 @@ setenv bootargs root=/dev/nfs rw ip=192.168.0.100:::::usb0 console=ttyO0,115200n
   nfsroot=192.168.0.1:/home/<user>/linux-kernel-labs/modules/nfsroot,nfsvers=3
 \end{verbatim}
 
+Once again, replace \code{<user>} by your actual user name.
+
 Now save this definition:
 \begin{verbatim}
 saveenv
diff --git a/labs/sysdev-application-debugging/sysdev-application-debugging.tex b/labs/sysdev-application-debugging/sysdev-application-debugging.tex
index cfa8670f..5dabdada 100644
--- a/labs/sysdev-application-debugging/sysdev-application-debugging.tex
+++ b/labs/sysdev-application-debugging/sysdev-application-debugging.tex
@@ -158,6 +158,8 @@ variable (on one line):
 buildroot-2019.02/output/staging
 \end{verbatim}
 
+Of course, replace \code{<user>} by your actual user name.
+
 And tell \code{gdb} to connect to the remote system:
 \begin{verbatim}
 (gdb) target remote <target-ip-address>:2345
diff --git a/labs/sysdev-buildroot/sysdev-buildroot.tex b/labs/sysdev-buildroot/sysdev-buildroot.tex
index a7c871fb..d836515e 100644
--- a/labs/sysdev-buildroot/sysdev-buildroot.tex
+++ b/labs/sysdev-buildroot/sysdev-buildroot.tex
@@ -88,6 +88,7 @@ button whenever you need more details about a given option:
   \item \code{Toolchain}: \code{Custom toolchain}
   \item \code{Toolchain path}: use the toolchain you built:
     \code{/home/<user>/x-tools/arm-training-linux-uclibcgnueabihf}
+    (replace \code{<user>} by your actual user name)
   \item \code{External toolchain gcc version}: \code{8.x}
   \item \code{External toolchain kernel headers series}: \code{4.16.x}
   \item \code{External toolchain C library}: \code{uClibc/uClibc-ng}
diff --git a/labs/sysdev-tinysystem/sysdev-tinysystem.tex b/labs/sysdev-tinysystem/sysdev-tinysystem.tex
index 66689be1..8ab71c04 100644
--- a/labs/sysdev-tinysystem/sysdev-tinysystem.tex
+++ b/labs/sysdev-tinysystem/sysdev-tinysystem.tex
@@ -63,6 +63,8 @@ IP address of your board will be \code{192.168.0.100}:
 \end{verbatim}
 \normalsize
 
+Of course, replace \code{<user>} by your actual user name.
+
 Make sure that the path and the options are on the same line.
 Also make sure that there is no space between the IP address and the NFS
 options, otherwise default options will be used for this IP address,
@@ -87,6 +89,8 @@ setenv bootargs root=/dev/nfs ip=192.168.0.100:::::eth0
    nfsroot=192.168.0.1:/home/<user>/embedded-linux-labs/tinysystem/nfsroot,nfsvers=3 rw
 \end{verbatim}
 
+Once again, replace \code{<user>} by your actual user name.
+
 Of course, you need to adapt the IP addresses to your exact network
 setup. Save the environment variables (with \code{saveenv}).
 
diff --git a/slides/sysdev-busybox/sysdev-busybox.tex b/slides/sysdev-busybox/sysdev-busybox.tex
index 4152193f..5ed95427 100644
--- a/slides/sysdev-busybox/sysdev-busybox.tex
+++ b/slides/sysdev-busybox/sysdev-busybox.tex
@@ -135,7 +135,7 @@
     \code{BusyBox Settings ->  Installation Options ->  BusyBox
       installation prefix}
   \item Add the cross-compiler path to the PATH environment variable:\\
-    \code{export PATH=/home/<user>/x-tools/arm-unknown-linux-uclibcgnueabi/bin:$PATH}
+    \code{export PATH=$HOME/x-tools/arm-unknown-linux-uclibcgnueabi/bin:$PATH}
   \item Compile BusyBox:\\
     \code{make}
   \item Install it (this creates a Unix directory structure symbolic

More information about the training-materials-updates mailing list