Skip to content

Commit a42f326

Browse files
committed
Cmdliner documentation update
1 parent c04eca5 commit a42f326

File tree

3 files changed

+7
-10
lines changed

3 files changed

+7
-10
lines changed

compiler/bin-wasm_of_ocaml/build_runtime.ml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@ let info =
2222
Info.make
2323
~name:"build-runtime"
2424
~doc:"Build standalone runtime. Used for separate compilation."
25-
~description:
26-
"Js_of_ocaml is a compiler from OCaml bytecode to Javascript. It makes it possible \
27-
to run pure OCaml programs in JavaScript environments like web browsers and \
28-
Node.js."
25+
~description:"Wasm_of_ocaml is a compiler from OCaml bytecode to WebAssembly."
2926

3027
let command =
3128
let t = Cmdliner.Term.(const Compile.run $ Cmd_arg.options_runtime_only) in

compiler/bin-wasm_of_ocaml/info.ml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ let make ~name ~doc ~description =
3232
; `S "AUTHORS"
3333
; `P "Jerome Vouillon, Hugo Heuzard."
3434
; `S "LICENSE"
35-
; `P "Copyright (C) 2010-2020."
35+
; `P "Copyright (C) 2010-2024."
3636
; `P
3737
"js_of_ocaml is free software, you can redistribute it and/or modify it under \
3838
the terms of the GNU Lesser General Public License as published by the Free \

compiler/bin-wasm_of_ocaml/link.ml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ let options =
4444
in
4545
let files =
4646
let doc =
47-
"Link the archive files [$(docv)]. The first archive must be a runtime produced by \
48-
$(b,wasm_of_ocaml build-runtime). The other archives can be produced by compiling \
49-
.cma or .cmo files."
47+
"Link the archive files [$(docv)]. Unless the $(b,-a) option is used, the first \
48+
archive must be a runtime produced by $(b,wasm_of_ocaml build-runtime). The other \
49+
archives can be produced by compiling .cma or .cmo files."
5050
in
5151
Arg.(non_empty & pos_all string [] & info [] ~docv:"FILES" ~doc)
5252
in
@@ -88,8 +88,8 @@ let info =
8888
~name:"link"
8989
~doc:"Wasm_of_ocaml linker"
9090
~description:
91-
"wasm_of_ocaml-link is a JavaScript linker. It can concatenate multiple JavaScript \
92-
files keeping sourcemap information."
91+
"wasm_of_ocaml-link links together several wasm_of_ocaml intermediate files to \
92+
produce either a library or some executable code."
9393

9494
let command =
9595
let t = Cmdliner.Term.(const f $ options) in

0 commit comments

Comments
 (0)