Add descriptive comments to the scripts

Author: JakubVanek

build/Dockerfile

@@ -1,5 +1,7 @@
 FROM debian:jessie
 
+# this is a customized version of ev3dev-jessie-cross image
+
 # setup repositories and install required packages
 COPY apt.sources.list.debian /etc/apt/sources.list
 RUN dpkg --add-architecture armel && \
@@ -48,14 +50,18 @@ RUN dpkg --add-architecture armel && \
         autotools-dev
 
 
-# copy build patches
+# copy build patches & scripts
 RUN mkdir /opt/jdkcross
 COPY *.patch *.sh /opt/jdkcross/
 RUN chmod +x /opt/jdkcross/*.sh
+
+# download JDK >=8
 RUN curl -SL http://download.java.net/java/GA/jdk9/9.0.1/binaries/openjdk-9.0.1_linux-x64_bin.tar.gz | tar -xzC /opt/jdkcross
 
+# this directory should be mounted
 VOLUME /build
 
+# prepare nonroot user
 COPY compiler.sudoers /etc/sudoers.d/compiler
 RUN chmod 0440 /etc/sudoers.d/compiler && \
     adduser --disabled-password --gecos \"\" compiler && \

build/build.sh

@@ -1,6 +1,10 @@
 #!/bin/bash
 cd /build/jdk9u
+
+# refresh patched build system
 bash ./common/autoconf/autogen.sh
+
+# configure the build
 bash ./configure --with-boot-jdk=/opt/jdkcross/jdk-9.0.1 \
                  --openjdk-target=arm-linux-gnueabi \
                  --with-abi-profile=arm-ev3 \
@@ -14,4 +18,24 @@ bash ./configure --with-boot-jdk=/opt/jdkcross/jdk-9.0.1 \
                  NM="arm-linux-gnueabi-gcc-nm" \
                  BUILD_AR="gcc-ar" \
                  BUILD_NM="gcc-nm"
+
+## Description ##
+# Use the downloaded JDK:      --with-boot-jdk=/opt/jdkcross/jdk-9.0.1
+# Cross-compiling for ARM:     --openjdk-target=arm-linux-gnueabi
+# Tune for ARM926EJ-S softfp:  --with-abi-profile=arm-ev3
+# Disable GUI:                 --enable-headless-only
+# Help to find freetype:       --with-freetype-lib=/usr/lib/arm-linux-gnueabi
+#                              --with-freetype-include=/usr/include
+# Build only the Client VM:    --with-jvm-variants=client
+# Add extra build flags:       --with-extra-cflags="-Wno-maybe-uninitialized -D__SOFTFP__"
+#   - Fix the build on new GCC: -Wno-maybe-uninitialized
+#   - Force softfloat runtime:  -D__SOFTFP__
+# Fix the "internal" string:   --with-version-string="9.0.1"
+# Fix for GCC and LTO objects: AR="arm-linux-gnueabi-gcc-ar"
+#                              NM="arm-linux-gnueabi-gcc-nm"
+#                              BUILD_AR="gcc-ar"
+#                              BUILD_NM="gcc-nm"
+
+
+# start building
 make clean images

build/fetch.sh

@@ -1,8 +1,14 @@
 #!/usr/bin/env bash
+
+# clone the root project
 cd /build
 hg clone http://hg.openjdk.java.net/jdk-updates/jdk9u/
 cd jdk9u
+
+# clone the rest of the tree
 bash ./get_source.sh
+
+# apply the EV3-specific patches
 patch -p1            < /opt/jdkcross/ev3.patch
 patch -p1 -d hotspot < /opt/jdkcross/float.patch