Replace PDF manual with html asciidoc one

As a checked in manual, the html version should be much more git-friendly
than a binary PDF file.

Also fix a sail documentation bug with empty filenames

Makefile

@@ -18,6 +18,7 @@ clean:
 
 asciidoc:
 	$(MAKE) -C doc/asciidoc
+	cp doc/asciidoc/manual.html manual.html
 
 docker:
 	docker build --tag sail:0.1 .

README.md

@@ -38,7 +38,7 @@ descriptions of the current state.
 This repository contains the implementation of Sail, together with
 some Sail specifications and related tools.
 
-* A manual, [manual.pdf](manual.pdf) with source (in [doc/](doc/))
+* A manual, [manual.html](manual.html) with source (in [doc/](doc/))
 
 * The Sail source code (in [src/](src/))
 

doc/asciidoc/Makefile

@@ -1,3 +1,5 @@
+SAIL_LOGO_PATH ?= etc/logo/sail_logo_square.png
+
 SAIL_PLUGIN ?= asciidoctor-sail
 
 SAIL_DOCS = sail_doc/riscv_duopod.json
@@ -64,7 +66,10 @@ parser.txt: ../../src/lib/parser.mly parser.sed
 manual.pdf: *.adoc $(SAIL_DOCS) $(INCS) $(TIKZ_FIGURES) parser.txt
 	asciidoctor-pdf manual.adoc -r $(SAIL_PLUGIN) -r asciidoctor-bibtex
 
-manual.html: *.adoc $(SAIL_DOCS) $(INCS) $(TIKZ_FIGURES) parser.txt manual.css sail_logo_square.png
+docinfo.html: docinfo.template
+	sed 's/SAIL_LOGO_PATH/$(shell echo $(SAIL_LOGO_PATH) | sed 's/\//\\\//g')/' $< > $@
+
+manual.html: *.adoc $(SAIL_DOCS) $(INCS) $(TIKZ_FIGURES) parser.txt manual.css docinfo.html
 	asciidoctor manual.adoc -r $(SAIL_PLUGIN) -r asciidoctor-bibtex
 
 .PHONY: clean

doc/asciidoc/docinfo.html → doc/asciidoc/docinfo.template

@@ -12,7 +12,7 @@
 <script>
   document.addEventListener("DOMContentLoaded", () => {
     var image = document.createElement('img')
-    image.setAttribute('src', 'sail_logo_square.png')
+    image.setAttribute('src', 'SAIL_LOGO_PATH')
     image.setAttribute('alt', 'Sail Logo')
     image.classList.add('logo')
     var toc = document.querySelector('#toc')

doc/asciidoc/language.adoc

@@ -177,7 +177,7 @@ assert(x @ y == 0xFFFF_0000);
 ----
 
 For historical reasons the `bit` type is not equal to `bits(1)`, and
-while this does simplify naïvely mapping the bits type into a (very
+while this does simplify naively mapping the bits type into a (very
 inefficient!) representation like `bit list` in Isabelle or OCaml, it
 might be something we reconsider in the future.