From 579c39ee8a44aa01af7707418615a773e1000588 Mon Sep 17 00:00:00 2001
From: John Ogness <john.ogness@linutronix.de>
Date: Tue, 19 Dec 2017 09:30:41 +0100
Subject: lx-trainer-vm: add finetuning comments

Clarify what the different finetuning steps are doing. Since some
of the steps are complicated, a description helps users to
determine if the finetuning steps are correct.

Signed-off-by: John Ogness <john.ogness@linutronix.de>
---
 lx-trainer-vm/lx-trainer-vm.xml | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'lx-trainer-vm')

diff --git a/lx-trainer-vm/lx-trainer-vm.xml b/lx-trainer-vm/lx-trainer-vm.xml
index 0cab693..42c38fe 100644
--- a/lx-trainer-vm/lx-trainer-vm.xml
+++ b/lx-trainer-vm/lx-trainer-vm.xml
@@ -100,14 +100,19 @@
 			</bydev>
 		</fstab>
 		<finetuning>
+			<!-- install armhf toolchain -->
 			<command>wget http://nereus/schulung-mirror/releases.linaro.org/components/toolchain/binaries/6.3-2017.05/arm-linux-gnueabihf/gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf.tar.xz</command>
 			<command>tar xJf gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf.tar.xz -C /opt</command>
 			<command>rm gcc-linaro-*.tar.xz</command>
+			<!-- install eclipse -->
 			<command>wget http://nereus/schulung-mirror/ftp.fau.de/eclipse/technology/epp/downloads/release/neon/3/eclipse-cpp-neon-3-linux-gtk-x86_64.tar.gz</command>
 			<command>tar xzf eclipse-cpp-*.tar.gz -C /opt</command>
 			<command>rm eclipse-cpp-*.tar.gz</command>
+			<!-- keep grub simple to minimize boot issues -->
 			<command>echo 'GRUB_GFXPAYLOAD_LINUX=text' | tee -a /etc/default/grub</command>
+			<!-- disable tomoyo or else the system won't boot -->
 			<command>sed -i -e 's/security=tomoyo/security=no-tomoyo/' /etc/default/grub</command>
+			<!-- setup german timezone, locale, keyboard -->
 			<command>echo 'Europe/Berlin' | tee /etc/timezone</command>
 			<command>cp -f /usr/share/zoneinfo/Europe/Berlin /etc/localtime</command>
 			<command>echo 'de_DE ISO-8859-1' | tee /etc/locale.gen</command>
@@ -125,11 +130,14 @@
 			<command>echo 'CHARMAP=UTF-8' | tee /etc/default/console-setup</command>
 			<command>echo 'CODESET=guess' | tee -a /etc/default/console-setup</command>
 			<command>locale-gen</command>
+			<!-- setup xterm with a large default font -->
 			<command>echo 'xterm*font: 10x20' | tee -a /etc/X11/Xresources/xterm</command>
+			<!-- setup devel user (relies on archive contents) -->
 			<command>cp -a /etc/default/useradd /etc/default/useradd.orig</command>
 			<command>echo 'SKEL=/etc/skel.devel' | tee -a /etc/default/useradd</command>
 			<adduser passwd="devel" shell="/bin/bash" groups="sudo,kvm,dialout">devel</adduser>
 			<command>mv -f /etc/default/useradd.orig /etc/default/useradd</command>
+			<!-- clear up some space -->
 			<rm>var/cache/apt/archives/*.deb</rm>
 		</finetuning>
 		<pkg-list>
-- 
cgit v1.2.3