aboutsummaryrefslogtreecommitdiffstats
path: root/docs/man.org
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 /docs/man.org
parent7dabf0b931036148fd7986d7d75624d81c07f146 (diff)
downloadvericert-8d8a3a544682a3689e99533ede019cd60a8e9ce6.tar.gz
vericert-8d8a3a544682a3689e99533ede019cd60a8e9ce6.zip
Update documentation links
Diffstat (limited to 'docs/man.org')
-rw-r--r--docs/man.org11
1 files changed, 5 insertions, 6 deletions
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>