Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix placeholders in dune subst documentation #1090

Merged
merged 1 commit into from
Aug 2, 2018
Merged

Conversation

emillon
Copy link
Collaborator

@emillon emillon commented Aug 2, 2018

They were substituted, leading to confusing documentation.

@emillon emillon force-pushed the fix-dune-subst-doc branch from 64e2d01 to 9dbf57e Compare August 2, 2018 14:10
@emillon emillon requested a review from rgrinberg August 2, 2018 14:10
Copy link
Member

@rgrinberg rgrinberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I prefer sprintf over string concatenation for this, but it's your call.

@emillon
Copy link
Collaborator Author

emillon commented Aug 2, 2018

Good idea. The alternative I had in mind was using hex escapes, but this wasn't great.

@emillon
Copy link
Collaborator Author

emillon commented Aug 2, 2018

Actually, using sprintf requires doubling each %, so I'll stay with concatenation.

They were substituted, leading to confusing documentation.

Signed-off-by: Etienne Millon <me@emillon.org>
@emillon emillon force-pushed the fix-dune-subst-doc branch from 9dbf57e to 7129564 Compare August 2, 2018 14:31
@rgrinberg rgrinberg merged commit 45e3335 into master Aug 2, 2018
@emillon
Copy link
Collaborator Author

emillon commented Aug 3, 2018

Thanks!

@emillon emillon deleted the fix-dune-subst-doc branch August 3, 2018 07:53
rgrinberg added a commit to rgrinberg/opam-repository that referenced this pull request Aug 6, 2018
CHANGES:

- Fix lookup of command line specified files when `--root` is given. Previously,
  passing in `--root` in conjunction with `--workspace` or `--config` would not
  work correctly (ocaml/dune#997, @rgrinberg)

- Add support for customizing env nodes in workspace files. The `env` stanza is
  now allowed in toplevel position in the workspace file, or for individual
  contexts. This feature requires `(dune lang 1.1)` (ocaml/dune#1038, @rgrinberg)

- Add `enabled_if` field for aliases and tests. This field controls whether the
  test will be ran using a boolean expression language. (ocaml/dune#819, @rgrinberg)

- Make `name`, `names` fields optional when a `public_name`, `public_names`
  field is provided. (ocaml/dune#1041, fix ocaml/dune#1000, @rgrinberg)

- Interpret `X` in `--libdir X` as relative to `PREFIX` when `X` is relative
  (ocaml/dune#1072, fix ocaml/dune#1070, @diml)

- Add support for multi directory libraries by writing
  `(include_subdirs unqualified)` (ocaml/dune#1034, @diml)

- Add `(staged_pps ...)` to support staged ppx rewriters such as ones
  using the OCaml typer like `ppx_import` (ocaml/dune#1080, fix ocaml/dune#193, @diml)

- Use `-opaque` in the `dev` profile. This option trades off binary quality for
  compilation speed when compiling .cmx files. (ocaml/dune#1079, fix ocaml/dune#1058, @rgrinberg)

- Fix placeholders in `dune subst` documentation (ocaml/dune#1090, @emillon, thanks
  @trefis for the bug report)

- Add locations to errors when a missing binary in PATH comes from a dune file
  (ocaml/dune#1096, fixes ocaml/dune#1095, @rgrinberg)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants