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

ref: clarify keys with examples #33

Merged
merged 4 commits into from
May 27, 2020
Merged

Conversation

liyishuai
Copy link
Member

We should clarify many more keys e.g. I don't know how to write tested_coq_nix_versions in my meta.yml.

Also, the supported tags wiki seems outdated after coq-community/docker-base#4 (comment).

@liyishuai liyishuai changed the title ref: clarify tested_coq_opam_versions ref: clarify keys with examples May 26, 2020
@Zimmi48
Copy link
Member

Zimmi48 commented May 27, 2020

I don't know how to write tested_coq_nix_versions in my meta.yml.

version_or_url can be either a version name already released in nixpkgs (as '8.10') or a URL of the form https://github.com/coq/coq-on-cachix/tarball/<branchname> where <branchname> can be master or a release branch like v8.12 (typically only used to test a project with branches of Coq that are still in alpha or beta.

@liyishuai
Copy link
Member Author

I don't know how to write tested_coq_nix_versions in my meta.yml.

version_or_url can be either a version name already released in nixpkgs (as '8.10') or a URL of the form https://github.com/coq/coq-on-cachix/tarball/<branchname>

I can see the Cachix branch names in https://github.com/coq/coq-on-cachix/branches.
Which page lists the available versions in nixpkgs?

@Zimmi48
Copy link
Member

Zimmi48 commented May 27, 2020

On this page, at the bottom, there is the list of supported Coq versions (currently, everything between 8.5 and 8.11). The top part of the page is also interesting since it lists the currently packaged libraries that can be specified as dependencies.

@liyishuai
Copy link
Member Author

I'm confused by coq_8_10 and version = "8.10.2". Which one does the version_or_url: '8.10' come from?
Feel free to push directly, since I'm not so familiar with Nix.

@Zimmi48
Copy link
Member

Zimmi48 commented May 27, 2020

The '8.10' syntax is used for convenience. It is transformed into coqPackages_8_10 in the default.nix template.

Feel free to push directly, since I'm not so familiar with Nix.

OK, let me try.

Copy link
Member

@erikmd erikmd left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @liyishuai @Zimmi48

@liyishuai liyishuai merged commit bad9a4b into coq-community:master May 27, 2020
@liyishuai liyishuai deleted the doc branch May 27, 2020 22:10
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.

3 participants