Reorganize repo folder structure

w3f · Jun 8, 2020 · 37bfc90 · 37bfc90
1 parent 9357167
commit 37bfc90
Show file tree

Hide file tree

Showing 23 changed files with 52 additions and 29 deletions.
diff --git a/.github/workflows/specification.yml b/.github/workflows/specification.yml
@@ -5,17 +5,19 @@ on:
     paths:
     - '.github/workflows/specification.yml'
     - '.github/apt-texmacs.asc'
-    - 'polkadot-host-spec/**'
+    - 'host-spec/**'
+    - 'runtime-spec/**'
   pull_request:
     paths:
     - '.github/workflows/specification.yml'
     - '.github/apt-texmacs.asc'
-    - 'polkadot-host-spec/**'
+    - 'host-spec/**'
+    - 'runtime-spec/**'
 
 jobs:
-  build:
-    name: Compile specification to PDF
-    runs-on: ubuntu-latest
+  build-spec-host:
+    name: Compile host specification
+    runs-on: ubuntu-18.04
     steps:
     - uses: actions/checkout@v2
     - name: Install dependencies
@@ -25,10 +27,27 @@ jobs:
         sudo apt-get update
         sudo apt-get install -y xvfb texmacs
     - name: Build host specification
-      run: xvfb-run texmacs --convert polkadot-host-spec/polkadot_host_spec.tm polkadot_host_spec.pdf --quit
+      run: make -C host-spec
     - name: Upload host specification
       uses: actions/upload-artifact@v1
       with:
-        name: polkadot_host_spec.pdf
-        path: polkadot_host_spec.pdf
+        name: host-spec.pdf
+        path: host-spec/host-spec.pdf
+
+  build-spec-runtime:
+    name: Compile runtime specification
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y texlive-luatex 
+    - name: Build runtime specification
+      run: make -C runtime-spec
+    - name: Upload runtime specification
+      uses: actions/upload-artifact@v1
+      with:
+        name: runtime-spec.pdf
+        path: runtime-spec/runtime-spec.pdf
 
diff --git a/README.md b/README.md
@@ -5,18 +5,18 @@
 
 Polkadot is a replicated sharded state machine designed to resolve the scalability and interoperability among blockchains. This repository serves as the point of reference for Polkadot Protocol. In this repo you will find:
 
-- The official [Polkadot Host Specification](./polkadot-host-spec/)
+- The official [Polkadot Host Specification](./host-spec/)
 - The official [Polkadot Conformance Testsuite](./test/)
 - A florishing [Polkadot Runtime Specification](./runtime-spec/)
 - Various other files used by the Polkadot spec team
 
 ## Polkadot Host Specification
 
-Here your can find the latest version of the [Polkadot Host Specification](./polkadot-host-spec/polkadot_host_spec.pdf)
+Here your can find the latest version of the [Polkadot Host Specification](./host-spec/host-spec.pdf)
 
-Please refer to the [Change Log](./polkadot-host-spec/pdre_change_log.org) and [PDF Diff](./polkadot-host-spec/polkadot_host_spec-diffed-updates.pdf) to review the history of changes to the specification.
+Please refer to the [Change Log](./host-spec/CHANGELOG.org) and [PDF Diff](./host-spec/host-spec-diffed-updates.pdf) to review the history of changes to the specification.
 
-For more details please refer [README.md](./polkadot-host-spec/README.md) to the specification.
+For more details please refer [README.md](./host-spec/README.md) to the specification.
 
 ## Polkadot Protocol Conformance Testsuite
 

diff --git a/polkadot-host-spec/pdre_change_log.org → host-spec/CHANGELOG.org b/polkadot-host-spec/pdre_change_log.org → host-spec/CHANGELOG.org
diff --git a/host-spec/Makefile b/host-spec/Makefile
@@ -0,0 +1,2 @@
+host-spec.pdf: host-spec.tm
+	xvfb-run texmacs --convert $< $@ --quit
diff --git a/polkadot-host-spec/README.md → host-spec/README.md b/polkadot-host-spec/README.md → host-spec/README.md
@@ -1,10 +1,10 @@
 # Polkadot Host Specification
 
-Here your can find the latest version of the ![Polkadot Host Specification](./polkadot_host_spec.pdf)
+Here your can find the latest version of the ![Polkadot Host Specification](./host-spec.pdf)
 
-Please refer to ![Change log](./pdre_change_log.org) to review the history of changes to the spec.
+Please refer to ![Change log](./CHANGELOG.org) to review the history of changes to the spec.
 
-Due to evolving nature of the protocol, to help the reader with identifying updates since last master released, those changes are marked in "green" (new version) vs "red" (old version) in ![polkadot_host_spec-diffed-updates.pdf](./polkadot_host_spec-diffed-updates.pdf).
+Due to evolving nature of the protocol, to help the reader with identifying updates since last master released, those changes are marked in "green" (new version) vs "red" (old version) in ![host-spec-diffed-updates.pdf](./host-spec-diffed-updates.pdf).
 
 ## Editing
 

diff --git a/polkadot-host-spec/aa-cryptoalgorithms.tm → host-spec/aa-cryptoalgorithms.tm b/polkadot-host-spec/aa-cryptoalgorithms.tm → host-spec/aa-cryptoalgorithms.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/ab-encodings.tm → host-spec/ab-encodings.tm b/polkadot-host-spec/ab-encodings.tm → host-spec/ab-encodings.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/ac-genesis.tm → host-spec/ac-genesis.tm b/polkadot-host-spec/ac-genesis.tm → host-spec/ac-genesis.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/ad-netmessages.tm → host-spec/ad-netmessages.tm b/polkadot-host-spec/ad-netmessages.tm → host-spec/ad-netmessages.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/ae-hostapi.tm → host-spec/ae-hostapi.tm b/polkadot-host-spec/ae-hostapi.tm → host-spec/ae-hostapi.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.11>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/af-legacyhostapi.tm → host-spec/af-legacyhostapi.tm b/polkadot-host-spec/af-legacyhostapi.tm → host-spec/af-legacyhostapi.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/ag-runtimeentries.tm → host-spec/ag-runtimeentries.tm b/polkadot-host-spec/ag-runtimeentries.tm → host-spec/ag-runtimeentries.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|<tuple|book|old-dots>>
 

diff --git a/polkadot-host-spec/c01-background.tm → host-spec/c01-background.tm b/polkadot-host-spec/c01-background.tm → host-spec/c01-background.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/c02-state.tm → host-spec/c02-state.tm b/polkadot-host-spec/c02-state.tm → host-spec/c02-state.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/c03-transition.tm → host-spec/c03-transition.tm b/polkadot-host-spec/c03-transition.tm → host-spec/c03-transition.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|<tuple|book|algorithmacs-style|old-dots>>
 

diff --git a/polkadot-host-spec/c04-networking.tm → host-spec/c04-networking.tm b/polkadot-host-spec/c04-networking.tm → host-spec/c04-networking.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/c05-bootstrapping.tm → host-spec/c05-bootstrapping.tm b/polkadot-host-spec/c05-bootstrapping.tm → host-spec/c05-bootstrapping.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|book>
 

diff --git a/polkadot-host-spec/c06-consensus.tm → host-spec/c06-consensus.tm b/polkadot-host-spec/c06-consensus.tm → host-spec/c06-consensus.tm
@@ -1,6 +1,6 @@
 <TeXmacs|1.99.12>
 
-<project|polkadot_host_spec.tm>
+<project|host-spec.tm>
 
 <style|<tuple|book|algorithmacs-style|old-dots>>
 

diff --git a/polkadot-host-spec/polkadot_host_spec.bib → host-spec/host-spec.bib b/polkadot-host-spec/polkadot_host_spec.bib → host-spec/host-spec.bib
diff --git a/polkadot-host-spec/polkadot_host_spec.tex → host-spec/host-spec.tex b/polkadot-host-spec/polkadot_host_spec.tex → host-spec/host-spec.tex
diff --git a/polkadot-host-spec/polkadot_host_spec.tm → host-spec/host-spec.tm b/polkadot-host-spec/polkadot_host_spec.tm → host-spec/host-spec.tm
@@ -1318,7 +1318,7 @@
     all keys and values stored in the state storage.|<pageref|auto-31>>
   </the-glossary>
 
-  <\bibliography|bib|tm-alpha|polkadot_host_spec>
+  <\bibliography|bib|tm-alpha|host-spec>
     <\bib-list|12>
       <bibitem*|Bur19><label|bib-burdges_schnorr_2019>Jeff Burdges.
       <newblock>Schnorr VRFs and signatures on the Ristretto group.

diff --git a/polkadot-host-spec/legacy-spec/spec.md → host-spec/legacy-spec/spec.md b/polkadot-host-spec/legacy-spec/spec.md → host-spec/legacy-spec/spec.md
diff --git a/runtime-spec/Makefile b/runtime-spec/Makefile
@@ -0,0 +1,2 @@
+runtime-spec.pdf: runtime-spec.tex
+	lualatex $<
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		host-spec.pdf: host-spec.tm
		xvfb-run texmacs --convert $< $@ --quit
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		runtime-spec.pdf: runtime-spec.tex
		lualatex $<