fix Makefile and README.md for 2018/mills

2018/mills/Makefile

@@ -1,41 +1,52 @@
 #!/usr/bin/env make
 #
-# 2018 makefile
+# IOCCC 2018 winning entry - mills
+
+################################################################################
 #
-# This work by Landon Curt Noll, Simon Cooper, and Leonid A. Broukhis
+# Regarding individual entries:
-# is licensed under:
+#
+# IOCCC winning entry code may not work on your system.  Even with standards,
+# conditions and build environments change, especially when it comes to more
+# extreme code such you might find in an IOCCC winner.  Moreover, what was
+# allowed and liked in one IOCCC contest may no longer be liked/allowed in
+# later IOCCC years.
+#
+# Corrections on winning author and fixing typos in remarks are VERY WELCOME.
+#
+# GitHub pull requests are welcome:
+#
+# If you have a patch that might make running an entry work in modern Unix-like
+# environments, please create a GitHub pull request for the IOCCC judges to
+# consider.
+#
+# Suggestions and corrections regarding Makefiles, winning author information,
+# fixing typos in remarks, and code patches are welcome via opening a GitHub
+# issue or better yet, by creating a GitHub pull request for the IOCCC judges
+# to consider.  To form a GitHub issue or GitHub pull, please visit:
+#
+# https://github.com/ioccc-src/winner
+#
+################################################################################
+
+# This work by Landon Curt Noll and Leonid A. Broukhis is licensed under:
 #
 #	Creative Commons Attribution-ShareAlike 3.0 Unported License.
 #
 # See: http://creativecommons.org/licenses/by-sa/3.0/
 
 
-################
+#############################
-# tool locations
+# shell used by this Makefile
-################
+#############################
 #
 SHELL= bash
-CP= cp
+
-CPP= cpp
+#######################
-GUNZIP= gunzip
+# common tool locations
-BUNZIP2= bunzip2
+#######################
-GZIP_PROG= gzip
+#
-BZIP2= bzip2
+include ../../var.mk
-CURL= curl
-DD= dd
-LD= ld
-MAKE= make
-RM= rm
-SED= sed
-TAR= tar
-TRUE= true
-MKDIR= mkdir
-MV= mv
-TR= tr
-GREP= grep
-SORT= sort
-UNIQ= uniq
-STRIP= strip
 
 # Set X11_LIBDIR to the directory where the X11 library resides
 #
@@ -49,28 +60,25 @@ X11_LIBDIR= /opt/X11/lib
 #X11_INCDIR= /usr/X11/include
 X11_INCDIR= /opt/X11/include
 
-# Compiler warnings
+# Common C compiler warnings to silence
 #
-#CWARN=
+#CSILENCE=
-CWARN= -Wall ${CSILENCE}
+CSILENCE= -Wno-gnu-empty-initializer -Wno-missing-field-initializers
-#CWARN= -Wall -Wextra
-#CWARN= -Wall -Wextra -pedantic ${CSILENCE}
-#CWARN= -Wall -Wextra -Weverything
-#CWARN= -Wall -Wextra -Weverything -pedantic
-#CWARN= -Wall -Wextra -Weverything -pedantic ${CSILENCE}
 
-# Silence warnings that ${CWARN} would normally complain about
+# Common C compiler warning flags
 #
-CSILENCE= -Wno-unused-result
+#CWARN= ${CSILENCE}
-#CSILENCE= -Wno-implicit-int
+#CWARN= -Wall ${CSILENCE}
+#CWARN= -Wall -Wextra ${CSILENCE}
+CWARN= -Wall -Wextra -pedantic ${CSILENCE}
 
-# compiler standard
+# Compiler standard
 #
 #CSTD=
 #CSTD= -ansi
-CSTD= -std=c11
+CSTD= -std=gnu17
 
-# compiler bit architecture
+# Compiler bit architecture
 #
 # Some entries require 32-bitness:
 # ARCH= -m32
@@ -82,20 +90,21 @@ CSTD= -std=c11
 #
 ARCH=
 
-# defines that are needed to compile
+# Defines that are needed to compile
 #
 CDEFINE=
-#CDEFINE= -DIOCCC=25
+#CDEFINE= -DIOCCC
 
-# include files that are needed to compile
+# Include files that are needed to compile
 #
 CINCLUDE=
 #CINCLUDE= -include stdlib.h
 #CINCLUDE= -include stdio.h
 #CINCLUDE= -include stdlib.h -include stdio.h
-#CINCLUDE= -I ${X11_INCDIR}
+#CINCLUDE= -I ${X11_INCDIR} -I ${X11_INCDIR}/X11
+#CINCLUDE= `${SDL2_CONFIG} --cflags`
 
-# optimization
+# Optimization
 #
 # Most compiles will safely use -O2.  Some can use only -O1 or -O.
 # A few compilers have broken optimizers or this entry make break
@@ -108,38 +117,56 @@ CINCLUDE=
 #OPT= -O2
 OPT= -O3
 
-# default flags for ANSI C compilation
+# Default flags for ANSI C compilation
 #
 CFLAGS= ${CSTD} ${CWARN} ${ARCH} ${CDEFINE} ${CINCLUDE} ${OPT}
 
 # Libraries needed to build
 #
 LIBS=
-#LIBS= -L ${X11_LIBDIR}
+#LIBS= -lm
+#LIBS= -L ${X11_LIBDIR} -lX11
+#LIBS= `${SDL2_CONFIG} --libs`
 
-# ANSI compiler
+# C compiler to use
-#
-# Set CC to the name of your ANSI compiler.
-#
-# Some entries seem to need gcc.  If you have gcc, set
-# both CC and MAY_NEED_GCC to gcc.
-#
-# If you do not have gcc, set CC to the name of your ANSI compiler, and
-# set MAY_NEED_GCC to either ${CC} (and hope for the best) or to just :
-# to disable such programs.
 #
 CC= cc
 #CC=clang
-MAY_NEED_GCC= gcc
+#CC=gcc
+
+# Compiler add-ons or replacements for clang only
+#
+ifeq ($(CC),clang)
+#
+CSILENCE+= -Wno-implicit-int-conversion -Wno-missing-variable-declarations \
+	-Wno-poison-system-directories -Wno-shorten-64-to-32
+#
+CWARN+= -Weverything
+#
+endif
+
+# Specific add-ons or replacements for gcc only
+#
+ifeq ($(CC),gcc)
+#
+#CSILENCE+=
+#
+#CWARN+=
+#
+endif
 
 
 ##############################
 # Special flags for this entry
 ##############################
 #
-OBJ= prog.o
+ENTRY= mills
+PROG= prog
+#
+OBJ= ${PROG}.o
+CSRC= ${PROG}.o
 DATA=
-TARGET= prog v0 v6
+TARGET= ${PROG} v0 v6
 #
 ALT_OBJ=
 ALT_TARGET=
@@ -158,62 +185,66 @@ V6_TAPE_URL= https://www.tuhs.org/Archive/Distributions/Research/Ken_Wellsch_v6/
 # build the entry
 #################
 #
-all: ${TARGET} ${DATA}
+all: data ${TARGET}
 	@${TRUE}
 
-prog: prog.c rk05.bsd.fs
+.PHONY: all alt data everything clean clobber install \
+	love haste waste maker easter_egg sandwich \
+	supernova deep_magic magic charon pluto
+
+${PROG}: ${PROG}.c rk05.bsd.fs
 	${CC} ${CFLAGS} -DI='"rk05.bsd.fs"' -DA=4096 -DS=0173030 -DW=MAP_PRIVATE -DT= -DX=5 -DY=128 \
-	      -DV=270 -DP='"89!>@@89T=@@89\"89DQ@K89$$89Q1@H0@@@P@1@@"' prog.c -o $@ ${LIBS}
+	      -DV=270 -DP='"89!>@@89T=@@89\"89DQ@K89$$89Q1@H0@@@P@1@@"' ${PROG}.c -o $@ ${LIBS}
 
 rk05.bsd.fs: empty.fs.bz2 builddisk.bsd bsd.img.bz2
-	@${RM} -f $@
+	${RM} -f $@
 	${BZIP2} -dc empty.fs.bz2 > rk05.bsd.fs
 	${BZIP2} -dc bsd.img.bz2 | ./builddisk.bsd
 
-builddisk.bsd: prog.c
+builddisk.bsd: ${PROG}.c
 	${CC} ${CFLAGS} -DI='"rk05.bsd.fs"' -DA=4096 -DS=0 -DW=MAP_SHARED -DT= -DX=0 -DY=0 -DV=270 \
 	    -DP='"Q@ 89D?A E@#?@$$D@H?<@E@$$8CA1@H8CJ4EH8CA1@L8CJ4FH)@!F@H%@$$1@H?@%89\"?<@89T89!Q@\"89$$89Q1@[%@#1@D<@ @EHO??@X@@@@@@@1@@"' \
-	    -o $@ prog.c
+	    -o $@ ${PROG}.c
 
 rk05.v6.fs: empty.fs.bz2 builddisk.v6 v6.img.bz2
 	@${RM} -f $@
 	${BZIP2} -dc empty.fs.bz2 > rk05.v6.fs
 	${BZIP2} -dc v6.img.bz2 | ./builddisk.v6
 
-builddisk.v6: prog.c
+builddisk.v6: ${PROG}.c
 	${CC} ${CFLAGS} -DI='"rk05.v6.fs"' -DA=4096 -DS=0 -DW=MAP_SHARED -DT= -DX=0 -DY=0 -DV=270 \
 	    -DP='"Q@ 89D?A E@#?@$$D@H?<@E@$$8CA1@H8CJ4EH8CA1@L8CJ4FH)@!F@H%@$$1@H?@%89\"?<@89T89!Q@\"89$$89Q1@[%@#1@D<@ @EHO??@X@@@@@@@1@@"' \
-	    -o $@ prog.c
+	    -o $@ ${PROG}.c
 
 empty.fs.bz2: boot.dat
-	@${RM} -f empty.fs
+	${RM} -f empty.fs
 	${DD} if=/dev/zero of=empty.fs count=10800
 	${DD} if=boot.dat of=empty.fs conv=notrunc
 	${BZIP2} empty.fs
 
-v0: prog.c Makefile v0.image.fs
+v0: ${PROG}.c Makefile v0.image.fs
 	@echo "This IOCCC25 Makefile preserves the state of v0.image.fs at the time it won."
 	@echo "If you want to look for v0.image.fs updates, try: ${CURL} ${IMAGE_FS_URL} -o v0.image.fs"
 	@echo "Warning: any updates from ${IMAGE_FS_URL} are unofficial and are not part of the IOCCC."
 	${CC} ${CFLAGS} -DI='"v0.image.fs"' -DA=4096 -DS=0 -DW=MAP_PRIVATE \
 	    -DT="INLCR|ICRNL,0,0,ECHO" -DX=5 -DY=128 -DV=200 \
-	    -DP='"89!?@@89T=@@89\"Q@M89DQ@L89$$89Q1@I0A@@P@X@@1@@"' prog.c -o $@
+	    -DP='"89!?@@89T=@@89\"Q@M89DQ@L89$$89Q1@I0A@@P@X@@1@@"' ${PROG}.c -o $@
 
 v6: empty.fs.bz2 builddisk.v6 v6.img.bz2 rk05.v6.fs
 	${CC} ${CFLAGS} -DI='"rk05.v6.fs"' -DA=4096 -DS=0173030 -DW=MAP_PRIVATE -DT= -DX=5 -DY=128 \
-	      -DV=270 -DP='"89!>@@89T=@@89\"89DQ@K89$$89Q1@H0@@@P@1@@"' prog.c -o $@ ${LIBS}
+	      -DV=270 -DP='"89!>@@89T=@@89\"89DQ@K89$$89Q1@H0@@@P@1@@"' ${PROG}.c -o $@ ${LIBS}
 
 v6.img.bz2: v6.tape.gz
 	@echo "This IOCCC25 Makefile preserves the state of v6.tape.gz at the time it won."
 	@echo "If you want to look for v6.tape.gz updates, try: ${CURL} ${V6_TAPE_URL} -o v6.tape.gz"
 	@echo "Warning: any updates from ${V6_TAPE_URL} are unofficial and are not part of the IOCCC."
-	@${RM} -f v6.tape
+	${RM} -f v6.tape
 	${GZIP_PROG} -c -d v6.tape.gz | ${DD} of=v6.img count=4000 skip=100
 	${BZIP2} v6.img
 
 # alternative executable
 #
-alt: ${ALT_TARGET}
+alt: data ${ALT_TARGET}
 	@${TRUE}
 
 # data files
@@ -221,39 +252,53 @@ alt: ${ALT_TARGET}
 data: ${DATA}
 	@${TRUE}
 
+# both all and alt
+#
+everything: all alt
+
 
 ###############
 # utility rules
 ###############
 #
-everything: all alt
-
 clean:
 	${RM} -f ${OBJ} ${ALT_OBJ}
+	@-if [ -f indent.c ]; then \
+	    echo ${RM} -f indent.c; \
+	    ${RM} -f indent.c; \
+	fi
 
 clobber: clean
 	${RM} -f ${TARGET} ${ALT_TARGET}
-	${RM} -f builddisk.bsd builddisk.v6 v0 rk05.bsd.fs rk05.v6.fs empty.fs.bz2 empty.fs v6.fs v6.img.bz2 v0.img
+	${RM} -f builddisk.bsd builddisk.v6 v0 rk05.bsd.fs rk05.v6.fs 
-	${RM} -f v6.tape
+	${RM} -f empty.fs.bz2 empty.fs v6.fs v6.img.bz2 v0.img v6.tape
 	@-if [ -e sandwich ]; then \
 	    ${RM} -f sandwich; \
 	    echo 'ate sandwich'; \
 	fi
 
-nuke: clobber
-	@${TRUE}
-
-dist_clean: nuke
-	@${TRUE}
-
 install:
-	@echo "Surely you are performing, Dr. May!"
+	@echo "Dr. Spock says that is not logical!"
 	@${TRUE}
 
-# backwards compatibility
+# you may be able to misunderstand the source by reading indent.c
 #
-build: all
+indent.c: ${PROG}.c
-	@${TRUE}
+	@if which "${GINDENT}" >/dev/null 2>&1; then \
+	    echo ${RM} -f $@; \
+	    ${RM} -f $@; \
+	    echo "${GINDENT} < $< > $@"; \
+	    ${GINDENT} < $< > $@; \
+	elif which "${INDENT}" >/dev/null 2>&1; then \
+	    echo ${RM} -f $@; \
+	    ${RM} -f $@; \
+	    echo "${INDENT} < $< > $@"; \
+	    ${INDENT} < $< > $@; \
+	else \
+	    echo "no intent tool found, ident $< yourself, sorry"; \
+	    echo "exit 1"; \
+	    exit 1; \
+	fi
 
 
 ##################
@@ -272,22 +317,19 @@ waste:
 	@echo 'haste'
 	@${TRUE}
 
-make:
+maker:
-	@echo 'Attend a maker faire'
+	@echo 'Participate in a maker faire'
 	@${TRUE}
 
 easter_egg:
-	@echo you expected to often mis-understand this $${RANDOM} magic
+	@echo "you expected to often misunderstand this $${RANDOM} magic"
-	@echo chongo '<was here>' "/\\oo/\\"
+	@echo "chongo '<was here>' /\\oo/\\"
-	@echo Eggy
+	@echo "Eggy"
 
-fabricate fashion form frame manufacture produce: make
+sandwich: easter_egg
-	@${TRUE}
-
-sandwich:
 	@if [ `id -u` -eq 0 ]; then \
 	    echo 'Okay.'; \
-	    echo $${RANDOM}`date +%s`$${RANDOM} > $@; \
+	    echo "$${RANDOM}`date +%s`$${RANDOM}" > $@; \
 	else \
 	    echo 'What? Make it yourself.'; \
 	    exit 1; \
@@ -297,18 +339,19 @@ sandwich:
 # as well as the West Coast Computer Faire and
 # you might be confused different.  :-)
 #
-supernova: nuke
+supernova: sandwich
 	@-if [ -r .code_anal ]; then \
 	    ${RM} -f .code_anal_v6; \
 	else \
 	    echo "planet deniers, like some members of the IAU, are so cute when they try to defend their logic"; \
 	fi
-	@echo A $@ helps ${MAKE} the elements that help form planets
+	@echo "A $@ helps ${MAKE} the elements that help form planets"
 	@${TRUE}
 
-deep_magic:
+deep_magic: supernova
 	@-if [ -r .code_anal ]; then \
-	    ccode_analysis --deep_magic 3a3fabb90892eeb2f610ae0f74a35a970060665a063ab702bd686c17c4ae07f6 --FNV1a_hash_256_bit "prog"; \
+	    ccode_analysis --deep_magic 7889066cdbdf09b0408021754586e895be641cc9be29e7eafd3ca65359541f17 \
+	    		   --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
 	else \
 	    echo "Wrong! Do it again!"; \
 	    sleep 2; \
@@ -320,7 +363,7 @@ deep_magic:
 
 magic: deep_magic
 	@-if [ -r .code_anal ]; then \
-	    ccode_analysis --mode 216091 --level 216193 --FNV1a_hash_256_bit "prog"; \
+	    ccode_analysis --level 20003 --mode 5717175 --FNV1a_hash_512_bit -v2 "${PROG}" "${PROG}.c"; \
 	else \
 	    echo "If you don't eat yer meat, you can't have any pudding!"; \
 	    echo "How can you have any pudding if you don't eat yer meat?!"; \
@@ -329,14 +372,14 @@ magic: deep_magic
 
 # The IOCCC resident astronomer states
 #
-charon: supernova
+charon: magic
-	@echo $@ is a dwarf planet
+	@echo "$@ is a dwarf planet"
-	@echo dwarf is a type of planet
+	@echo "dwarf is a type of planet"
-	@echo $@ is a planet
+	@echo "therefore IAU, $@ is a planet"
 
-pluto: supernova
+pluto: charon
 	${MAKE} charon
-	@echo $@ is a dwarf planet
+	@echo "$@ is a dwarf planet"
-	@echo dwarf is a type of planet
+	@echo "dwarf is a type of planet"
-	@echo $@ is a planet
+	@echo "therefore, $@ is a planet"
-	@echo get used to having lots of planets becasue supernovae can ${MAKE} a lot of them
+	@echo "having lots of planets is good feature because supernovae can help ${MAKE} a lot of them"

2018/mills/README.md

@@ -1,22 +1,31 @@
 # Best of show
 
-Christopher Mills <mrxo@sonic.net>  
+    Christopher Mills <mrxo@sonic.net>  
-Twitter: @MisterXopher  
+    Twitter: @MisterXopher  
 
+# To build:
 
-## Judges' comments:
+```sh
-### To use:
+make
+```
 
-    make
+### To run:
-    ./prog
+
+```sh
+./prog
+```
 
 ### Try:
 
-    make
+```sh
-    ./prog
+./prog
-    (At the ">boot" prompt, type return)
+```
-    (At the ":" prompt, type "rk(0,0)rkunix")
+
-    NOTE: To quit, press Control-E
+At the ">boot" prompt, type return
+
+At the ":" prompt, type "rk(0,0)rkunix"
+
+NOTE: To quit, press Control-E
 
 ### Selected Judges Remarks:
 
@@ -26,16 +35,19 @@ Do small machines only need small programs?  This program weighs in at just
 This program can take you back to the start of everything, it is possible to
 run v0. Just type:
 
-    make
+```sh
-    ./v0
+./v0
+```
 
-    NOTE: To quit v0, press Control-E
+NOTE: To quit v0, press Control-E
 
 You will be greeted with a familiar prompt of "login". The username and
 password are "dmr" and "dmr". To make things more familiar you'll need to
 create '.' as it hasn't been invented yet on this image!
 
-    @ ln dd dmr .
+```sh
+@ ln dd dmr .
+```
 
 An "ls" will reveal that C hasn't been invented yet! IOBCC anyone? The
 compiler is "bc". It producess assembly, which will then need to be assembled
@@ -44,31 +56,34 @@ together in this order "ops.s bl.s hello.s bi.s" to produce a.out!
 But wait, we said this was the start of it all! This program can also run a
 program that replaces an even larger machine that can run BSD 2.9. To start this,
 
-    make
+```sh
-    ./prog
+./prog
+```
 
-    (At the ">boot" prompt, type return)
+At the ">boot" prompt, type return
-    (At the ":" prompt, type "rk(0,0)rkunix")
+
-    NOTE: To quit prog, press Control-E
+At the ":" prompt, type "rk(0,0)rkunix"
+
+NOTE: To quit prog, press Control-E
 
 This should now be very familiar and it is possible to compile and run one of
 the very first IOCCC entires "mullender.c"
 
 But wait, there is even more!  Try:
 
-    make
+```sh
-    ./v6
+./v6
+```
 
-    (At the "@" prompt, type "rkunix")
+At the "@" prompt, type "rkunix"
-    NOTE: To quit v6, press Control-E
+
+NOTE: To quit v6, press Control-E
 
 ## Author's comments:
 
 >   *This IOCCC entry is dedicated to the late Dennis M. Ritchie*
 
-
+### The Program
-The Program
-===========
 
 Since this is the 25th "annual" IOCCC, I thought I should mark the occasion
 with a look back to its earliest roots.  At the same time the contest enters
@@ -87,8 +102,7 @@ can build versions that can run each of the following:
 
 For reasons to be described in a bit, the last (BSD 2.9) is the default.
 
-Building and Running BSD 2.9
+### Building and Running BSD 2.9
-----------------------------
 
 To run BSD 2.9, do `make` to build `prog` and then `./prog` to run it.
 
@@ -267,8 +281,7 @@ code, and they use the same name for the disk (`rk05.fs`), if you want to go
 back to the BSD simulation, you should either delete `rk05.fs` or do a
 `make clean` before you do a `make`.
 
-Building and Running UNIX v0
+### Building and Running UNIX v0
-----------------------------
 
 We now set the Wayback Machine to the very start of it all, 1969.
 
@@ -424,8 +437,7 @@ number of differences still:
 As usual, when you are done exploring UNIX v0, type Control-E to exit the
 simulator.
 
-About the Program
+### About the Program
-=================
 
 The program came about when I was looking for something to honor the pending
 50th anniversary of the C language (because of the mercurial nature of IOCCC
@@ -522,8 +534,7 @@ polling interval to a few polls per tick, so that simulation remains
 responsive.  Since we use the real wall-clock time, this means that the
 emulated system will see time advance at the correct rate.
 
-Licencing Fun
+### Licencing Fun
--------------
 
 So now I have a system that can run UNIX v0.  One problem remains...  I don't
 have permission to submit UNIX v0 to the IOCCC.  It is not my code and the
@@ -554,8 +565,7 @@ condition that it will not assert copyright rights for non-commercial use.
 So the newer UNIXes are in the clear.  I doubt anyone actually cares about
 version 0 either, but technically it's still under copyright.
 
-PDP-11/40
+### PDP-11/40
----------
 
 So if I have a PDP-7 emulator, how do I run operating systems that expect a
 PDP-11?  Simple...  *I emulate a PDP-11/40 on the PDP-7*.  I have written
@@ -628,8 +638,7 @@ window on the dawn of the UNIX era.  I feel that someone should complete the
 circle here by emulating a VAX 780 on the PDP-11 and run 4.2BSD on it, so that
 we can get the [original runtime environment used for the first IOCCC] [13].
 
-Compile-time Options
+### Compile-time Options
---------------------
 
 The following command flags control the compilation:
 
@@ -661,13 +670,11 @@ The following command flags control the compilation:
     quoting here -- there is at least three levels going on.  In particular,
     you will need to escape `$` as `$$` to protect it from `make`.
 
-What is the ASCII art supposed to be?
+### What is the ASCII art supposed to be?
--------------------------------------
 
 The ASCII art represents a torn piece of [paper tape] [14].
 
-Acknowledgements
+### Acknowledgements
-----------------
 
 None of this could have been possible without the hard work of
 
@@ -717,12 +724,10 @@ time...
 [17]: http://bitsavers.trailing-edge.com       "Bitsavers.org"
 [18]: https://www.bell-labs.com/usr/dmr/www/   "DMR Homepage"
 
+## Copyright:
 
---------------------------------------------------------------------------------
-<!--
 (c) Copyright 1984-2018, [Leo Broukhis, Simon Cooper, Landon Curt Noll][judges] - All rights reserved
 This work is licensed under a [Creative Commons Attribution-ShareAlike 3.0 Unported License][cc].
 
 [judges]: http://www.ioccc.org/judges.html
 [cc]: http://creativecommons.org/licenses/by-sa/3.0/
--->