File tree Expand file tree Collapse file tree 3 files changed +19
-19
lines changed
Expand file tree Collapse file tree 3 files changed +19
-19
lines changed Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ data become validated, we will list it here.
1010
1111== Quick links
1212
13- * https://riscv-software-src.github.io/riscv-unified-db/index.html[The **UNOFFICIAL** latest UDB-generated RISC-V specifications].
13+ * https://riscv-software-src.github.io/riscv-unified-db/index.html[The latest UDB-generated **UNOFFICIAL** RISC-V specifications].
1414* UDB Documentation
1515** xref:doc/schemas.adoc[Schema documentation]
1616** xref:doc/idl.adoc[ISA Description Language (IDL)]
Original file line number Diff line number Diff line change 1+ Generate an HTML site for one or more versions of the manual (./do -- desc for options)
2+
3+ == Usage
4+
5+ Options:
6+
7+ * MANUAL_NAME: The database name (key) of the manual to generate.
8+ * VERSIONS: A comma-separated list of versions to generate, or "all".
9+
10+ Examples:
11+
12+ ./do gen:html_manual MANUAL_NAME=isa VERSIONS=20191008,20240411
13+ ./do gen:html_manual MANUAL_NAME=isa VERSIONS=all
14+
15+ Result:
16+
17+ A static HTML website will be written into gen/manual/MANUAL_NAME/<hash of versions>/html
Original file line number Diff line number Diff line change @@ -377,24 +377,7 @@ rule %r{#{MANUAL_GEN_DIR}/[^/]+/[^/]+/riscv-isa-manual/README.md} => ["#{$root}/
377377end
378378
379379namespace :gen do
380- html_manual_desc = <<~DESC
381- Generate an HTML site for one or more versions of the manual (./do --desc for options)
382-
383- Options:
384-
385- * MANUAL_NAME: The database name (key) of the manual to generate.
386- * VERSIONS: A comma-separated list of versions to generate, or "all".
387-
388- Examples:
389-
390- ./do gen:html_manual MANUAL_NAME=isa VERSIONS=20191008,20240411
391- ./do gen:html_manual MANUAL_NAME=isa VERSIONS=all
392-
393- Result:
394-
395- A static HTML website will be written into gen/manual/MANUAL_NAME/<hash of versions>/html
396- DESC
397- desc html_manual_desc
380+ desc File . read ( "#{ File . dirname ( __FILE__ ) } /README.adoc" )
398381 task :html_manual do
399382 raise ArgumentError , "Missing required environment variable MANUAL_NAME\n \n #{ html_manual_desc } " if ENV [ "MANUAL_NAME" ] . nil?
400383 raise ArgumentError , "Missing required environment variable VERSIONS\n \n #{ html_manual_desc } " if ENV [ "VERSIONS" ] . nil?
You can’t perform that action at this time.
0 commit comments