aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2022-02-27 16:35:21 +0000
committerYann Herklotz <git@yannherklotz.com>2022-02-27 16:35:21 +0000
commit8d8a3a544682a3689e99533ede019cd60a8e9ce6 (patch)
treea2605f27e8231581ca2b0a711bafca1d6cc94dfe
parent7dabf0b931036148fd7986d7d75624d81c07f146 (diff)
downloadvericert-8d8a3a544682a3689e99533ede019cd60a8e9ce6.tar.gz
vericert-8d8a3a544682a3689e99533ede019cd60a8e9ce6.zip
Update documentation links
-rw-r--r--docs/documentation.org12
-rw-r--r--docs/man.org11
-rw-r--r--docs/res/install-deps.el1
-rw-r--r--docs/res/publish-html.el12
4 files changed, 25 insertions, 11 deletions
diff --git a/docs/documentation.org b/docs/documentation.org
index e951f83..85bc8fd 100644
--- a/docs/documentation.org
+++ b/docs/documentation.org
@@ -48,10 +48,10 @@ Free Documentation License''.
:CUSTOM_ID: building
:END:
-#+transclude: [[file:~/projects/vericert/README.org::#building][file:~/projects/vericert/README.org::#building]] :only-contents :exclude-elements "headline property-drawer"
-#+transclude: [[file:~/projects/vericert/README.org::#downloading-compcert][file:~/projects/vericert/README.org::#downloading-compcert]] :level 2
-#+transclude: [[file:~/projects/vericert/README.org::#setting-up-nix][file:~/projects/vericert/README.org::#setting-up-nix]] :level 2
-#+transclude: [[file:~/projects/vericert/README.org::#makefile-build][file:~/projects/vericert/README.org::#makefile-build]] :level 2
+#+transclude: [[file:~/projects/vericert/README.org::#building][file:../README.org::#building]] :only-contents :exclude-elements "headline property-drawer"
+#+transclude: [[file:~/projects/vericert/README.org::#downloading-compcert][file:../README.org::#downloading-compcert]] :level 2
+#+transclude: [[file:~/projects/vericert/README.org::#setting-up-nix][file:../README.org::#setting-up-nix]] :level 2
+#+transclude: [[file:~/projects/vericert/README.org::#makefile-build][file:../README.org::#makefile-build]] :level 2
** Testing
@@ -132,6 +132,10 @@ $ echo $?
50
#+end_src
+** Man pages
+
+#+transclude: [[file:man.org][file:man.org]] :exclude-elements "keyword" :level 3
+
* Unreleased Features
:PROPERTIES:
:EXPORT_FILE_NAME: unreleased
diff --git a/docs/man.org b/docs/man.org
index f4d8aef..cb6143f 100644
--- a/docs/man.org
+++ b/docs/man.org
@@ -1,6 +1,5 @@
#+title: vericert
#+man_class_options: :section-id "1"
-#+export_file_name: vericert.1
#+options: toc:nil num:nil
#+html_head_extra: <style>body{font-family:monospace;max-width:60em}h1{text-align:center}dt{font-weight:700}dd{margin-bottom:1em}</style>
@@ -14,19 +13,19 @@ vericert - A formally verified high-level synthesis tool.
* DESCRIPTION
-** HLS Options
+** HLS Options:
- --no-hls :: Do not use HLS and generate standard flow
- --simulate :: Simulate the result with the Verilog semantics
- --debug-hls :: Add debug logic to the Verilog
- --initialise-stack :: initialise the stack to all 0s
-** HLS Optimisations
+** HLS Optimisations:
- -fschedule :: Schedule the resulting hardware [off]
- -fif-conversion :: If-conversion optimisation [off]
-** General options
+** General options:
- -stdlib <dir> :: Set the path of the Compcert run-time library
- -v :: Print external commands before invoking them
@@ -36,7 +35,7 @@ vericert - A formally verified high-level synthesis tool.
- -conf <file> :: Read configuration from file
- @<file> :: Read command line options from <file>
-** Tracing Options
+** Tracing Options:
- -dprepro :: Save C file after preprocessing in <file>.i
- -dparse :: Save C file after parsing and elaboration in <file>.parsed.c
@@ -53,7 +52,7 @@ vericert - A formally verified high-level synthesis tool.
- -sdump :: Save info for post-linking validation in <file>.json
- -o <file> :: Generate output in <file>
-** Diagnostic options
+** Diagnostic options:
- -Wall :: Enable all warnings
- -W<warning> :: Enable the specific <warning>
diff --git a/docs/res/install-deps.el b/docs/res/install-deps.el
index 9440db5..09cf4ae 100644
--- a/docs/res/install-deps.el
+++ b/docs/res/install-deps.el
@@ -8,3 +8,4 @@
(package-install 'org)
(package-install 'org-contrib)
(package-install 'org-transclusion)
+(package-install 'htmlize)
diff --git a/docs/res/publish-html.el b/docs/res/publish-html.el
index 68de36d..a9c7a9d 100644
--- a/docs/res/publish-html.el
+++ b/docs/res/publish-html.el
@@ -5,8 +5,18 @@
(require 'org-transclusion)
(require 'ox)
(require 'ox-html)
+(require 'htmlize)
-(setq org-transclusion-exclude-elements nil)
+(setq org-transclusion-exclude-elements nil
+ org-html-head-include-default-style nil
+ org-html-head-include-scripts nil
+ org-html-postamble-format '(("en" ""))
+ org-html-postamble t
+ org-html-divs '((preamble "header" "header")
+ (content "article" "content")
+ (postamble "footer" "postamble"))
+ org-html-doctype "html5"
+ org-html-htmlize-output-type 'css)
(org-transclusion-add-all)
(org-html-export-to-html)