Merge branch 'feature/pipeline-docs-fix' into 'develop'

Docgen changes

See merge request spexeah/asuro!27

.gitlab-ci.yml

@@ -1,25 +1,23 @@
 stages:
-  - Generate Stub and Versions
+  - Compile Versions
-  - Generate Version Files
   - Compile Sources
   - Link
-  - Generate ISO
-  - Generate Sources List
   - Generate Documentation
+  - Deploy
 
-compile_stub:
+cache:
-  stage: Generate Stub and Versions
+  - key: ${CI_COMMIT_REF_SLUG}
-  script: 
-    - chmod +x ./compile_stub.sh
-    - ./compile_stub.sh
-  artifacts:
     paths:
-      - lib/stub.o
+      - lib/*.o
+      - bin/kernel.bin
+      - doc
 
-vergen:
+before_script:
-  stage: Generate Stub and Versions
+  - chmod +x *.sh
-  script: 
+
-    - chmod +x ./compile_vergen.sh
+versions:
+  stage: Compile Versions
+  script:
     - ./compile_vergen.sh
   artifacts:
     paths:
@@ -29,71 +27,47 @@ vergen:
 compile_sources:
   stage: Compile Sources
   script:
-    - chmod +x ./compile_sources.sh
+    - rm -f lib/*.so
     - ./compile_sources.sh
-  artifacts:
-    paths:
-      - lib/*.o
-  dependencies:
-    - compile_stub
-    - vergen
   needs:
-    - vergen
+    - versions
-    - compile_stub
 
 link:
   stage: Link
   script:
-    - chmod +x ./compile_link.sh
+    - ./compile_stub.sh
     - ./compile_link.sh
-  artifacts:
-    paths:
-      - bin/kernel.bin
-  dependencies:
-    - compile_sources
   needs:
+    - versions
     - compile_sources
 
 isogen:
-  stage: Generate ISO
+  stage: Deploy
   script:
-    - chmod +x ./compile_isogen.sh
     - ./compile_isogen.sh
-    - chmod +x ./compile_sumgen.sh
     - ./compile_sumgen.sh
   artifacts:
     paths:
       - ./Asuro.iso
       - ./release/checksum.svg
-  dependencies:
-    - link
   needs:
     - link
 
-sourcelist:
-  stage: Generate Sources List
-  script:
-    - chmod +x ./compile_sourcelist.sh
-    - ./compile_sourcelist.sh
-  artifacts:
-    paths:
-      - ./sources.list
-  dependencies:
-    - vergen
-  needs:
-    - vergen
-
 docgen:
   stage: Generate Documentation
+  only:
+    - master
+    - develop
   script:
-    - chmod +x ./compile_docs.sh
+    - ./compile_sourcelist.sh
     - ./compile_docs.sh
+    # Remove comments when we want to use gitlab pages.
+    #- cp doc public
+  allow_failure: true
   artifacts:
     paths:
-      - ./doc/*
+      - doc
-  dependencies:
+      #- public/*
-    - vergen
+      #- ./sources.list
-    - sourcelist
   needs:
-    - vergen
+    - versions
-    - sourcelist

Dockerfile

@@ -2,18 +2,22 @@ FROM ubuntu:latest
 
 VOLUME ["/code"]
 
+ENV DEBIAN_FRONTEND=noninteractive
 RUN dpkg --add-architecture i386
-RUN apt-get update
+RUN apt-get update && apt-get install -y \
-RUN apt-get install nasm curl make:i386 binutils:i386 xorriso grub-pc-bin dos2unix -y
+	curl dos2unix wget git make nasm binutils:i386 xorriso grub-pc-bin && \
-RUN apt-get clean
+	apt-get clean my room
-RUN curl https://sourceforge.net/projects/freepascal/files/Linux/2.6.4/fpc-2.6.4.i386-linux.tar/download --output fpc.tar -L && \
-	tar -xf fpc.tar
 
-WORKDIR ./fpc-2.6.4.i386-linux
+SHELL ["/bin/bash", "-c"]
-RUN ./install.sh
+ARG FPC_VERSION=2.6.4
+RUN curl -sL https://sourceforge.net/projects/freepascal/files/Linux/$FPC_VERSION/fpc-$FPC_VERSION.i386-linux.tar/download | tar -xf - && \
+	pushd fpc-$FPC_VERSION.i386-linux && ./install.sh && popd && \
+	rm -rf fpc-$FPC_VERSION.i386-linux
 
 COPY compile.sh /compile.sh
-RUN mkdir /code
+ADD https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver /usr/bin/semver
+RUN mkdir /code && chmod +x /usr/bin/semver
 WORKDIR /code
 RUN find . -type f -print0 | xargs -0 dos2unix
-ENTRYPOINT ["/bin/bash", "/compile.sh"]
+ENTRYPOINT ["/bin/bash", "-c"]
+CMD ["/compile.sh"]

compile.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 ERRCOUNT=0
 echo " "
 echo "======================="
@@ -7,49 +7,32 @@ echo "Asuro Compilation"
 echo " "
 
 #Compile Stub.asm
-./compile_stub.sh
+rm lib/*
-if [ $? -ne 0 ]
+
-then
+runOrFail() {
-	echo "Failed to compile stub!"
+	local binary=$1
-	ERRCOUNT=$((ERRCOUNT+1))	
+	local errorText=$2
-else
+	if $binary; then
-	echo "Success."
+		echo "Success."
-fi
+	else
+		echo "$errorText"
+		ERRCOUNT=$((ERRCOUNT+1))
+	fi
+}
+
+runOrFail $(pwd)/compile_stub.sh "Failed to compile stub!"
 
 #Generate .pas with versioning headers.
-./compile_vergen.sh
+runOrFail $(pwd)/compile_vergen.sh "Versions failed to compile"
 
 #Compile all .pas sources
-./compile_sources.sh
+runOrFail $(pwd)/compile_sources.sh "Failed to compile FPC Sources!"
-if [ $? -ne 0 ]
-then
-	echo " "
-	echo "Failed to compile FPC Sources!"
-	ERRCOUNT=$((ERRCOUNT+1))	
-else
-	echo " "
-	echo "Success."
-fi
 
 #Link into a binary.
-./compile_link.sh
+runOrFail $(pwd)/compile_link.sh "Failed linking!"
-if [ $? -ne 0 ]
-then
-	echo "Failed linking!"
-	ERRCOUNT=$((ERRCOUNT+1))
-else
-	echo "Success."
-fi
 
 #Generate an ISO with GRUB as the Bootloader.
-./compile_isogen.sh
+runOrFail ./compile_isogen.sh "Failed to create ISO!"
-if [ $? -ne 0 ]
-then
-	echo "Failed to create ISO!"
-	ERRCOUNT=$((ERRCOUNT+1))
-else
-	echo "Success."
-fi
 
 #Call generate final artifacts based on failure or success of the above.
 if [ "$ERRCOUNT" -ne "0" ]
@@ -59,4 +42,4 @@ else
 	./compile_finish.sh "success"
 fi
 
-cd ..
+cd ..

compile_checksum.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 echo > checksums.md5
 for directory in $(find src/ -maxdepth 10 -type d); do
 	for filename in $directory/*.pas; do

compile_docs.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 echo " "
 echo "======================="
 echo " "
@@ -14,5 +14,4 @@ echo "Removing old docs"
 rm -rf ./doc/*
 echo "Generating Docs..."
 ./pasdoc/bin/pasdoc -N "Asuro" -T "Asuro OS Documentation" -O "html" -E ./doc/ -S sources.list --use-tipue-search
-echo "Docgen finished."
+echo "Docgen finished."
-exit 0

compile_finish.sh

@@ -1,8 +1,8 @@
-#/bin/sh
+#!/usr/bin/env bash
 echo " "
 echo "======================="
 echo " "
-if [ "$1" == "failed" ]
+if [[ "$1" == "failed" ]]
 then
 	echo "Errors Occurred, please review."
 	wget -q https://img.shields.io/badge/build-failed-red.svg -O release/build.svg 2>/dev/null

compile_isogen.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 echo " "
 echo "======================="
 echo " "

compile_link.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 echo " "
 echo "======================="
 echo " "

compile_sourcelist.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 echo " "
 echo "======================="
 echo " "

compile_sources.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 echo " "
 echo "======================="
 echo " "

compile_stub.sh

@@ -1,8 +1,7 @@
-#!/bin/sh
+#!/usr/bin/env bash
 echo " "
 echo "======================="
 echo " "
 echo "Compiling Stub..."
 echo " "
-rm lib/*
 nasm -f elf src/stub/stub.asm -o lib/stub.o

compile_sumgen.sh

@@ -1,4 +1,4 @@
-#/bin/sh
+#!/usr/bin/env bash
 echo " "
 echo "======================="
 echo " "

compile_vergen.sh

@@ -1,4 +1,5 @@
-#!/bin/bash
+#!/usr/bin/env bash
+set -e
 echo " "
 echo "======================="
 echo " "
@@ -8,56 +9,67 @@ chmod +x ./compile_checksum.sh
 ./compile_checksum.sh
 outfile="src/include/asuro.pas"
 file="version"
-while IFS=: read -r line;do
+{
-	major=$(echo $line | awk '{print $1}')
+	# this script requires semver tool
-	minor=$(echo $line | awk '{print $2}')
+	wget -q https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver -O bin/semver && chmod +x bin/semver
-	sub=$(echo $line | awk '{print $3}')
+	export PATH="$(pwd)/bin:$PATH"
-	release=$(echo $line | awk '{print $4}')
+}
-done <"$file"
+tagref=$(git describe --tags)
+revision=$(git rev-parse --short=8 HEAD)
+major=$(semver get major $tagref)
+minor=$(semver get minor $tagref)
+sub=$(semver get patch $tagref)
+version=$(semver get release $tagref)
+release=$(semver get prerel $tagref)
+build=$(semver get build $tagref)
 linecount=$(./loc.sh | awk '{print $1}')
 sourcecount=$(find src -type f | wc -l)
 drivercount=$(find src/driver -type f | wc -l)
-revision=$(git rev-list --all --count)
 fpcversion=$(fpc -h | grep -m 1 version | awk '{print $5}')
 makeversion=$(make -v | grep GNU | awk '{print $3}' | grep -v GNU)
 nasmversion=$(nasm -v | awk '{print $3'})
 compiledate=$(date +"%d/%m/%y")
 compiletime=$(date +"%T")
 checksum=$(md5sum checksums.md5 | awk '{print $1}')
-echo "unit asuro;" > $outfile
+
-echo " " >> $outfile
+[[ -n "$release" ]] && version="$version-$release"
-echo "interface" >> $outfile
+cat > $outfile <<EOF
-echo " " >> $outfile
+unit asuro;
-echo "const" >> $outfile
+ 
-echo "     VERSION       = '$major.$minor.$sub-$revision$release';" >> $outfile
+interface
-echo "     VERSION_MAJOR = '$major';" >> $outfile
+ 
-echo "     VERSION_MINOR = '$minor';" >> $outfile
+const
-echo "     VERSION_SUB   = '$sub';" >> $outfile
+     VERSION       = '$version';
-echo "     REVISION      = '$revision';" >> $outfile
+     VERSION_MAJOR = '$major';
-echo "     RELEASE       = '$release';" >> $outfile
+     VERSION_MINOR = '$minor';
-echo "     LINE_COUNT    = $linecount;" >> $outfile
+     VERSION_SUB   = '$sub';
-echo "     FILE_COUNT    = $sourcecount;" >> $outfile
+     REVISION      = '$revision';
-echo "     DRIVER_COUNT  = $drivercount;" >> $outfile
+     RELEASE       = '$release';
-echo "     FPC_VERSION   = '$fpcversion';" >> $outfile
+     LINE_COUNT    = $linecount;
-echo "     NASM_VERSION  = '$nasmversion';" >> $outfile
+     FILE_COUNT    = $sourcecount;
-echo "     MAKE_VERSION  = '$makeversion';" >> $outfile
+     DRIVER_COUNT  = $drivercount;
-echo "     COMPILE_DATE  = '$compiledate';" >> $outfile
+     FPC_VERSION   = '$fpcversion';
-echo "     COMPILE_TIME  = '$compiletime';" >> $outfile
+     NASM_VERSION  = '$nasmversion';
-echo "     CHECKSUM      = '$checksum';" >> $outfile
+     MAKE_VERSION  = '$makeversion';
-echo " " >> $outfile
+     COMPILE_DATE  = '$compiledate';
-echo "implementation" >> $outfile
+     COMPILE_TIME  = '$compiletime';
-echo " " >> $outfile
+     CHECKSUM      = '$checksum';
-echo "end." >> $outfile
+ 
+implementation
+ 
+end.
+EOF
 echo "Generating release info..."
-wget -q https://img.shields.io/badge/version-$major.$minor.$sub--$revision$release-blue.svg -O release/version.svg 2>/dev/null
+set +e # These can fail on branches and such, for now
-wget -q https://img.shields.io/badge/revision-$revision-blue.svg -O release/revision.svg 2>/dev/null
+wget -q https://img.shields.io/badge/version-$major.$minor.$sub--$revision$release-blue.svg -O release/version.svg
-wget -q https://img.shields.io/badge/release-$release-blue.svg -O release/release.svg 2>/dev/null
+wget -q https://img.shields.io/badge/revision-$revision-blue.svg -O release/revision.svg
-wget -q https://img.shields.io/badge/lines-$linecount-blueviolet.svg -O release/lines.svg 2>/dev/null
+wget -q https://img.shields.io/badge/release-$release-blue.svg -O release/release.svg
-wget -q https://img.shields.io/badge/files-$sourcecount-blueviolet.svg -O release/files.svg 2>/dev/null
+wget -q https://img.shields.io/badge/lines-$linecount-blueviolet.svg -O release/lines.svg
-wget -q https://img.shields.io/badge/drivers-$drivercount-blueviolet.svg -O release/drivers.svg 2>/dev/null
+wget -q https://img.shields.io/badge/files-$sourcecount-blueviolet.svg -O release/files.svg
-wget -q https://img.shields.io/badge/FPC_version-$fpcversion-lightgrey.svg -O release/fpcversion.svg 2>/dev/null
+wget -q https://img.shields.io/badge/drivers-$drivercount-blueviolet.svg -O release/drivers.svg
-wget -q https://img.shields.io/badge/NASM_version-$nasmversion-lightgrey.svg -O release/nasmversion.svg 2>/dev/null
+wget -q https://img.shields.io/badge/FPC_version-$fpcversion-lightgrey.svg -O release/fpcversion.svg
-wget -q https://img.shields.io/badge/MAKE_version-$makeversion-lightgrey.svg -O release/makeversion.svg 2>/dev/null
+wget -q https://img.shields.io/badge/NASM_version-$nasmversion-lightgrey.svg -O release/nasmversion.svg
-wget -q https://img.shields.io/badge/release_date-$compiledate-lightgrey.svg -O release/date.svg 2>/dev/null
+wget -q https://img.shields.io/badge/MAKE_version-$makeversion-lightgrey.svg -O release/makeversion.svg
-wget -q https://img.shields.io/badge/fingerprint-$checksum-important.svg -O release/fingerprint.svg 2>/dev/null
+wget -q https://img.shields.io/badge/release_date-$compiledate-lightgrey.svg -O release/date.svg
+wget -q https://img.shields.io/badge/fingerprint-$checksum-important.svg -O release/fingerprint.svg
 echo "Done versioning."

src/driver/storage/AHCI.pas

@@ -12,15 +12,11 @@
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
-{ ************************************************
+{ 
-  * Asuro
+	Drivers->Storage->AHCI - AHCI SATA Driver.
-  * Unit: Drivers/AHCI
+	
-  * Description: AHCI SATA Driver
+	@author(Aaron Hance <ah@aaronhance.me>)
-  ************************************************
+}
-  * Author: Aaron Hance
-  * Contributors: 
-  ************************************************ }
-
 unit AHCI;
 
 interface

src/driver/storage/ATA_ISR.pas

@@ -12,15 +12,11 @@
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
-{ ************************************************
+{ 
-  * Asuro
+	Drivers->Storage->ATA_ISR - Primary ATA IRQ.
-  * Unit: Drivers/ISR46
+	
-  * Description: Primary ATA IRQ
+	@author(Aaron Hance <ah@aaronhance.me>)
-  ************************************************
+}
-  * Author: Aaron Hance
-  * Contributors: 
-  ************************************************ }
-
 unit ATA_ISR;
 
 interface

src/driver/storage/asfs.pas

@@ -12,16 +12,11 @@
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
-{ ************************************************
+{ 
-  * Asuro
+	Drivers->Storage->ASFS - Asuro Filesystem Driver.
-  * Unit: Drivers/storage/asfs
+	
-  * Description: asfs file system driver
+	@author(Aaron Hance <ah@aaronhance.me>)
-  * 
+}
-  ************************************************
-  * Author: Aaron Hance
-  * Contributors: 
-  ************************************************ }
-
 unit asfs;
 
 interface

src/progmanager.pas

@@ -12,6 +12,11 @@
 //  See the License for the specific language governing permissions and
 //  limitations under the License.
 
+{ 
+	ProgManager - Central initialization for terminal registered, baked-in programs.
+	
+	@author(Kieron Morris <kjm@kieronmorris.me>)
+}
 unit progmanager;
 
 interface
@@ -23,6 +28,7 @@ uses
     edit, netlog, themer,
     memview, udpcat, dhclient, vbeinfo;
 
+{ Initialize all baked-in programs }
 procedure init();
 
 implementation