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

Document what Dune project (name) does #1532

Closed
brendanlong opened this issue Nov 11, 2018 · 2 comments
Closed

Document what Dune project (name) does #1532

brendanlong opened this issue Nov 11, 2018 · 2 comments

Comments

@brendanlong
Copy link
Contributor

I found that Dune requires (name) when I try to pin ocaml-freetds, but it doesn't seem to require it for local building. Is this something I should add to all projects? What do I do if git repo contains multiple packages (i.e. pgx has 4 opam packages).

The documentation just says:

Sets the name of the project

While I'm looking at this, it looks like (version)'s documentation is similar and (fmt) is completely missing.

@ghost
Copy link

ghost commented Nov 12, 2018

It's required by dune subst. Otherwise, it is currently just used in error message. You should add one for any project that you release. The only reason it is optional is so that you don't have to come up with one for quick hacking. Regarding the version, it's basically pending #880.

brendanlong added a commit to brendanlong/dune that referenced this issue Nov 12, 2018
brendanlong added a commit to brendanlong/dune that referenced this issue Nov 16, 2018
brendanlong added a commit to brendanlong/dune that referenced this issue Nov 16, 2018
brendanlong added a commit to brendanlong/dune that referenced this issue Nov 28, 2018
See discussion in ocaml#1532

Signed-off-by: Brendan Long <self@brendanlong.com>
brendanlong added a commit to brendanlong/dune that referenced this issue Nov 28, 2018
See discussion in ocaml#1532

Signed-off-by: Brendan Long <self@brendanlong.com>
@rgrinberg
Copy link
Member

I'm closing this issue as the documentation change requested has been committed. @brendanlong feel free to re-open for further improvements (or just send PR's)

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

No branches or pull requests

2 participants