matthieu
/
dune
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix placeholders in dune subst documentation 

They were substituted, leading to confusing documentation.

Signed-off-by: Etienne Millon <me@emillon.org>
This commit is contained in:
Etienne Millon 2018-08-02 14:08:01 +00:00
parent 7132e6eb55
commit 7129564d12
2 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.md
View File

@ -27,6 +27,9 @@ next
- Use `-opaque` in the `dev` profile. This option trades off binary quality for
compilation speed when compiling .cmx files. (#1079, fix #1058, @rgrinberg)
- Fix placeholders in `dune subst` documentation (#1090, @emillon, thanks
@trefis for the bug report)
1.0.1 (19/07/2018)
------------------

16
bin/main.ml
View File

@ -1279,6 +1279,10 @@ let exec =
in
(term, Term.info "exec" ~doc ~man)
(** A string that is "%%VERSION%%" but not expanded by [dune subst] *)
let literal_version =
"%%" ^ "VERSION%%"
let subst =
let doc =
"Substitute watermarks in source files."
@ -1294,17 +1298,17 @@ let subst =
[ `S "DESCRIPTION"
; `P {|Substitute $(b,%%ID%%) strings in source files, in a similar fashion to
what topkg does in the default configuration.|}
; `P {|This command is only meant to be called when a user pins a package to
its development version. Especially it replaces $(b,%%VERSION%%) strings
by the version obtained from the vcs. Currently only git is supported and
the version is obtained from the output of:|}
; `P ({|This command is only meant to be called when a user pins a package to
its development version. Especially it replaces $(b,|} ^ literal_version
^{|) strings by the version obtained from the vcs. Currently only git is
supported and the version is obtained from the output of:|})
; `Pre {| \$ git describe --always --dirty|}
; `P {|$(b,dune subst) substitutes the variables that topkg substitutes with
the defatult configuration:|}
; var "NAME" "the name of the project (from the dune-project file)"
; var "VERSION" "output of $(b,git describe --always --dirty)"
; var "VERSION_NUM" "same as $(b,%%VERSION%%) but with a potential leading \
'v' or 'V' dropped"
; var "VERSION_NUM" ("same as $(b," ^ literal_version ^
") but with a potential leading 'v' or 'V' dropped")
; var "VCS_COMMIT_ID" "commit hash from the vcs"
; opam "maintainer"
; opam "authors"