Split into separate CC/DWARF/ELF documents and convert to AsciiDoc

Closes: #204

Author: jrtc27

.github/workflows/build.yml

@@ -15,23 +15,20 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      # Ubuntu 20.04's Pandoc treats the LaTeX in our YAML file as Markdown
-      # that needs escaping, so use a new enough release (the latest at time of
-      # writing).
-      - name: Download Pandoc
-        run: wget 'https://github.com/jgm/pandoc/releases/download/2.12/pandoc-2.12-1-amd64.deb'
-
       - name: Install packages
-        run: sudo apt-get update && sudo apt-get install -y make texlive-latex-extra ./pandoc-2.12-1-amd64.deb
+        run: sudo apt-get update && sudo apt-get install -y make ruby
+
+      - name: Install gems
+        run: sudo gem install asciidoctor asciidoctor-pdf
 
       - name: Build
         run: make
 
       - name: Upload artifact
         uses: actions/upload-artifact@v2
         with:
-          name: riscv-elf.pdf
-          path: riscv-elf.pdf
+          name: riscv-abi.pdf
+          path: riscv-abi.pdf
 
   draft-release:
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'
@@ -41,7 +38,7 @@ jobs:
       - name: Download artifact
         uses: actions/download-artifact@v2
         with:
-          name: riscv-elf.pdf
+          name: riscv-abi.pdf
           path: ./
 
       - name: Get current date
@@ -66,8 +63,8 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: riscv-elf.pdf
-          asset_name: riscv-elf.pdf
+          asset_path: riscv-abi.pdf
+          asset_name: riscv-abi.pdf
           asset_content_type: application/pdf
 
   release:
@@ -78,7 +75,7 @@ jobs:
       - name: Download artifact
         uses: actions/download-artifact@v2
         with:
-          name: riscv-elf.pdf
+          name: riscv-abi.pdf
           path: ./
 
       - name: Upload release asset
@@ -88,6 +85,6 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ github.event.release.upload_url }}
-          asset_path: riscv-elf.pdf
-          asset_name: riscv-elf.pdf
+          asset_path: riscv-abi.pdf
+          asset_name: riscv-abi.pdf
           asset_content_type: application/pdf

Makefile

@@ -1,4 +1,4 @@
-NAME = riscv-elf
+NAME = riscv-abi
 
 DATE = $(shell date '+%B %d, %Y')
 
@@ -7,20 +7,13 @@ all: $(NAME).pdf
 
 .PHONY: clean
 clean:
-	rm -rf build
 	rm -f $(NAME).pdf
 
-build:
-	mkdir -p $@
-
-build/include.md: $(NAME).md | build
-	awk '/<!-- END COPYRIGHT -->/{b=0} b{print} /<!-- BEGIN COPYRIGHT -->/{b=1}' $< > $@
-
-build/body.md: $(NAME).md | build
-	awk 'BEGIN{b=1} /<!-- BEGIN TITLE -->/{b=0} b{print} /<!-- END TITLE -->/{b=1}' $< > $@
-
-build/include.tex: build/include.md | build
-	pandoc -o $@ $<
-
-$(NAME).pdf: build/body.md build/include.tex $(NAME).yaml | build
-	pandoc --metadata-file $(NAME).yaml --metadata date="$(DATE)" -o $@ $<
+$(NAME).pdf: $(NAME).adoc $(wildcard *.adoc)
+	asciidoctor-pdf \
+	    -a compress \
+	    -a date="$(DATE)" \
+	    -a pdf-style=resources/themes/risc-v_spec-pdf.yml \
+	    -a pdf-fontsdir=resources/fonts \
+	    -v \
+	    $< -o $@

images/draft.png

@@ -0,0 +1,16 @@
+This RISC-V ELF psABI specification document is
+
+(C) 2016 Palmer Dabbelt <palmer@dabbelt.com> +
+(C) 2016 Stefan O'Rear <sorear2@gmail.com> +
+(C) 2016 Kito Cheng <kito[email protected]> +
+(C) 2016-2017 Andrew Waterman <aswaterman@gmail.com> +
+(C) 2016-2017 Michael Clark <michaeljclark@mac.com> +
+(C) 2017-2019 Alex Bradbury <asb@asbradbury.org> +
+(C) 2017 David Horner <ds2horner@gmail.com> +
+(C) 2017 Max Nordlund <max[email protected]> +
+(C) 2017 Karsten Merker <merker@debian.org> +
+(C) 2019 Sam Elliott <selliott@lowrisc.org>
+
+It is licensed under the Creative Commons Attribution 4.0 International
+License (CC-BY 4.0).  The full license text is available at
+https://creativecommons.org/licenses/by/4.0/.

images/risc-v_logo.png

@@ -0,0 +1,35 @@
+:company: RISC-V.org
+:revdate: {date}
+:revnumber: 0.01
+:revremark: Pre-release version
+//development: assume everything can change
+//stable: assume everything could change
+//frozen: of you implement this version you assume the risk that something might change because of the public review cycle  but we expect little to no change.
+//ratified: you can implement this and be assured nothing will change. if something needs to change due to an errata or enhancement, it will come out in a new extension. we do not revise extensions.
+:url-riscv: http://riscv.org
+:doctype: book
+:preface-title: Preamble
+:colophon:
+:appendix-caption: Appendix
+:imagesdir: images
+:title-logo-image: image:risc-v_logo.png[pdfwidth=3.25in,align=center]
+//:back-cover-image: image:backpage.png[opacity=25%]
+:experimental:
+:reproducible:
+:icons: font
+:lang: en
+:listing-caption: Listing
+:sectnums:
+:toc: left
+:toclevels: 3
+:source-highlighter: pygments
+ifdef::backend-pdf[]
+:source-highlighter: coderay
+endif::[]
+:data-uri:
+:hide-uri-scheme:
+:stem: latexmath
+:footnote:
+:xrefstyle: short
+
+include::preamble.adoc[]