[build] Tree & scripts housekeeping

Author: mfld-fr

.gitignore

@@ -1,42 +1,29 @@
 #
 # IDE local settings
 #
+
 .project
-.DS_Store
 
 #
 # Build ignores
 #
+
 .config
 .config.old
 
 *.o
 *.a
-*.1.gz
-Kbuild
-cross
-
-#
-# Never ignore these
-#
-!.gitignore
+*.map
 
 #
 # Normal output and testing dirs
 #
+
+cross
 target
 
 #
-# Backups / patches
+# Never ignore these
 #
-*~
-*.orig
-*.rej
 
-#
-# Debugging stuff
-#
-*.map
-core
-.gdb_history
-.gdbinit
+!.gitignore

Makefile

@@ -5,29 +5,6 @@ endif
 
 include $(TOPDIR)/Make.defs
 
-#########################################################################
-# Variables
-
-# Specify the configuration shell to use.
-
-CFG_SHELL	:= $(shell \
-	     if [ -x "$$bash" ]; \
-		then echo $$bash ; \
-		else if [ -x /bin/bash ]; \
-			then echo /bin/bash ; \
-			else if [ -x /usr/bin/bash ]; \
-				then echo /usr/bin/bash ; \
-				else if [ -x /usr/local/bin/bash ]; \
-					then echo /usr/local/bin/bash ; \
-					else echo sh ; \
-				     fi ; \
-			     fi ; \
-		     fi ; \
-	     fi)
-
-#########################################################################
-# Rules
-
 .PHONY: all clean kconfig defconfig config menuconfig
 
 all: .config
@@ -36,7 +13,7 @@ all: .config
 	$(MAKE) -C elks all
 	$(MAKE) -C elkscmd all
 	$(MAKE) -C image all
-	-$(MAKE) -C elksemu PREFIX='$(TOPDIR)/cross' elksemu
+	$(MAKE) -C elksemu PREFIX='$(TOPDIR)/cross' elksemu
 
 clean:
 	$(MAKE) -C libc clean
@@ -61,10 +38,8 @@ kconfig:
 defconfig:
 	@yes '' | ${MAKE} config
 
-config:	elks/arch/i86/drivers/char/KeyMaps/config.in kconfig
-	$(CFG_SHELL) config/Configure config.in
-
-menuconfig:	elks/arch/i86/drivers/char/KeyMaps/config.in kconfig
-	$(CFG_SHELL) config/Menuconfig config.in
+config: elks/arch/i86/drivers/char/KeyMaps/config.in kconfig
+	config/Configure config.in
 
-#########################################################################
+menuconfig: elks/arch/i86/drivers/char/KeyMaps/config.in kconfig
+	config/Menuconfig config.in

README.md

@@ -5,8 +5,7 @@
 ![main](https://github.com/elks-org/elks/workflows/main/badge.svg)
 
 
-What is this ?
---------------
+# What is this ?
 
 This is a project to write a Linux-like OS for systems based on the Intel
 IA16 architecture (16 bits processors: 8088, 8086, 80188, 80186, 80286,
@@ -17,61 +16,79 @@ recent SBC / SoC / FPGA that reuse the huge hardware & software legacy
 from that popular platform.
 
 
-How to build ?
---------------
+# How to build ?
 
-To build ELKS, you need a cross build tool chain, mainly based on the latest
-GCC-IA16 (DEV86 including BCC was used for previous versions, but has been
-dropped because it was obsolete and no more actively maintained).
+## Prerequisites
 
-Among the dependencies there are packages (for Debian and Ubuntu distros):
-texinfo bison flex libgmp-dev libmpfr-dev libmpc-dev libncurses5-dev
+To build ELKS, you need a GNU development environment, including:
+- flex
+- bison
+- texinfo
+- libncurses5-dev
 
-A script is provided to automatically download and build that tool chain:
+## Quickstart
 
-  'tools/build.sh'
+A script is provided to automate the whole build process
+(cross toool chain, configuration, kernel, user land and target image),
+and make it easier for ELKS newbies:
 
-Note: all the scripts must be executed within the top folder 'elks/' as the
-current one.
+`./build.sh`
 
-A script is provided to automate the whole build process (configuration,
-kernel, user land and target image) and make it easier for ELKS newbies:
+Note: all the scripts must be executed within the top folder of
+the ELKS repository as the current one (= TOPDIR).
 
-  './build.sh'
+If you want to clean everything up afterwards (except the cross tool chain):
 
-If you want to clean everything up afterwards, run './build.sh clean'
-and it will run 'make clean' in the build directories for you.
+`./clean.sh`
 
-The general build procedure for ELKS is as follows:
+## Build steps
 
-* Set up your environment (PATH, TOPDIR and CROSSDIR):
+1- Create a `cross` subfolder:
 
-  '. tools/env.sh' (note the '.' before the script)
+`mkdir cross`
 
-* Build the cross chain in 'cross/' (see above)
+2- Build the cross tool chain, mainly based on a recent GCC-IA16
+(DEV86 including BCC was used for previous versions, but has been
+dropped because it was obsolete and no more maintained):
 
-* Configure the build chain, the kernel, the user land and the target image
-  format:
+`tools/build.sh`
 
-  'make menuconfig'
+Ubuntu 18.04 LTS users: as this step is quite long,
+you can download an already built cross folder from here:
+https://github.com/elks-org/elks/actions?query=workflow%3Across
 
-* Build the kernel, the user land and the target image:
+3- Set up your environment (PATH, TOPDIR and CROSSDIR):
 
-  'make all'
+`. env.sh` (note the '.' before the script)
 
-The target root folder is built in 'target/', and depending on your
-configuration, that folder is packed as either a floppy disk image (fd1440,
-fd1680, fd1200, fd720, fd360, without MBR), a hard-disk image (hd, with MBR),
-or a file image (ROM, TAR), into the '/image' folder.
+4- Configure the kernel, the user land and the target image format:
 
-Before writting the image on the real device, you can test it first on QEMU
-with './qemu.sh' (will configure QEMU as an ISA system).
+`make menuconfig`
 
+5- Build the kernel, the user land and the target image:
 
-More information
-----------------
+`make all`
 
-Questions? Problems? Patches? Open an issue in this project! You can also join
-and email the 'Linux-8086' list at [email protected].
+The target root folder is built in `target`', and depending on your
+configuration, that folder is packed as either a floppy disk image
+(fd360, fd720, fd1440), a hard disk image (hd, without MBR),
+or a file image (ROM, TAR), into the `image` folder.
 
-More information in the Documentation folder: Documentation/index.html
+6- Before writting that image on the real medium,
+you can test it first on QEMU:
+
+`./qemu.sh`
+
+7- You can then modify the configuration or the sources and repeat from the
+step 4 after cleaning only the kernel, the user land and the image:
+
+`make clean`
+
+
+# More information
+
+Questions? Problems? Patches? Open an issue in this project!
+
+You can also join and email the 'Linux-8086' list at [email protected].
+
+More information in the Documentation folder: `Documentation/index.html`

build.sh

@@ -1,25 +1,11 @@
 #!/bin/bash
 
-# Quick and dirty build script for ELKS
+# Full build (including the cross tool chain)
+
 # Arguments:
-#   - 'clean': full cleanup
 #   - 'auto' : continuous integration context
 
-DELAY=7
-
-pause () {
-	echo
-	# 'read -n/-s' are bashisms, so work around them
-	if [ -z "$BASH_VERSION" ]
-		then
-		echo "Starting in $DELAY seconds."
-		sleep $DELAY
-		else
-		echo -n "Press a key to continue... "
-		read -n 1 -s 2>/dev/null || sleep $DELAY
-	fi
-	echo
-}
+SCRIPTDIR="$(dirname "$0")"
 
 clean_exit () {
 	E="$1"
@@ -31,56 +17,48 @@ clean_exit () {
 	exit $E
 }
 
-# Build environment setup
-# TODO: check script status on return
-. tools/env.sh
+# Environment setup
+
+. "$SCRIPTDIR/env.sh"
+[ $? -ne 0 ] && clean_exit 1
 
 # Build cross tools if not already
+
 if [ "$1" != "auto" ]; then
 	mkdir -p "$CROSSDIR"
-	test -x "$CROSSDIR/bin/ia16-elf-gcc" || tools/build.sh || clean_exit 1
+	test -f "$CROSSDIR/.gcc.install" || tools/build.sh || clean_exit 1
 fi
 
-# Working directory
-WD="$(pwd)"
-
-### Clean if asked
-if [ "$1" = "clean" ]
-	then echo
-	echo "Cleaning up. Please wait."
-	sleep 1
-	for X in config elks elkscmd
-		do cd $X; make clean; cd "$WD"
-	done
-	clean_exit 0
-fi
+# Configure all
 
-### Configure all (kernel + user land)
 if [ "$1" = "auto" ]; then
-	echo "Invoking 'make defconfig'."
+	echo "Invoking 'make defconfig'..."
 	make defconfig || clean_exit 2
 else
 	echo
 	echo "Now invoking 'make menuconfig' for you to configure the system."
 	echo "The defaults should be OK for many systems, but you may want to review them."
-	pause
+	echo -n "Press ENTER to continue..."
+	read
 	make menuconfig || clean_exit 2
 fi
 
 test -e .config || clean_exit 3
 
-### Clean all
+# Clean kernel, user land and image
+
 if [ "$1" != "auto" ]; then
 	echo "Cleaning all..."
-	sleep 1
 	make clean || clean_exit 4
 	fi
 
-### Build all
-echo "Building all..."
+# Build kernel, user land and image
 # Forcing single threaded build because of dirty dependencies (see #273)
+
+echo "Building all..."
 make -j1 all || clean_exit 5
-test -e elks/arch/i86/boot/Image || clean_exit 6
 
-echo "Target image is under 'image'."
+# Success
+
+echo "Target image is in 'image' folder."
 clean_exit 0

clean.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# Full clean (except the cross build chain)
+
+SCRIPTDIR="$(dirname "$0")"
+
+# Environment setup
+
+. "$SCRIPTDIR/env.sh"
+[ $? -ne 0 ] && exit 1
+
+make -C config clean
+
+rm -f .config
+rm -f .config.old
+
+make -C include clean
+
+make clean

config/Configure

@@ -1,4 +1,4 @@
-#! /bin/sh
+#!/bin/bash
 #
 # This script is used to configure the ELKS kernel.
 #

config/Makefile

@@ -6,6 +6,3 @@ all:
 
 clean:
 	$(MAKE) -C lxdialog clean
-	-rm ../.config
-	-rm ../.config.old
-	-rm ../include/autoconf.h

config/Menuconfig

@@ -1,4 +1,4 @@
-#! /bin/sh
+#!/bin/bash
 #
 # This script is used to configure the ELKS kernel.
 #

elkscmd/bootblocks/Makefile

@@ -33,8 +33,8 @@ boot_probe.o: boot_probe.S
 
 boot_minix.o: boot_minix.c
 
-clean realclean:
-	rm -f *.o *.bin
+clean:
+	rm -f *.o *.bin *.map
 
 # Boot blocks are not part of the target filesystem
 # but embedded in the target disk image

elksemu/.gitignore

@@ -0,0 +1 @@
+elksemu