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

Split off reals into package coq-fourcolor-reals that is a dependency of coq-fourcolor #64

Merged
merged 3 commits into from
Nov 14, 2024

Conversation

palmskog
Copy link
Member

@palmskog palmskog commented Nov 6, 2024

As discussed on Zulip. This is a draft until CI details are figured out.

@palmskog palmskog marked this pull request as ready for review November 6, 2024 09:17
@palmskog palmskog requested a review from proux01 November 6, 2024 09:17
@palmskog
Copy link
Member Author

palmskog commented Nov 6, 2024

@proux01 I just copied over Makefile boilerplate from Analysis, does it look reasonable to you?

@palmskog
Copy link
Member Author

@ybertot any chance for a review here? This follows closely the boilerplate currently used in MathComp-Analysis.

@ybertot
Copy link
Collaborator

ybertot commented Nov 14, 2024

I am essentially happy with the way the implementation is written. I think it would be good to add some documentation of real package in the README.md file.

@ybertot
Copy link
Collaborator

ybertot commented Nov 14, 2024

I tried to understand where to change the text in the meta.yml file, but I was not able to locate the sources for the building and installing instructions.

@palmskog
Copy link
Member Author

I tried to understand where to change the text in the meta.yml file, but I was not able to locate the sources for the building and installing instructions.

Nothing has changed in meta.yml or the README how the project is built. The "default" make action still builds the whole project, and opam install coq-fourcolor installs all files. The way this PR is structured, the only differences are in how opam packages are structured.

How do you propose we should document coq-fourcolor-reals (beyond the description already in the .opam file)? It may be just confusing to people interested in only the Four Color Theorem to mention this package.

@proux01
Copy link
Contributor

proux01 commented Nov 14, 2024

Can we keep a meta.yml? My understanding was that this only supports single packages (hence the fact we don't use it in mathcomp).

@ybertot
Copy link
Collaborator

ybertot commented Nov 14, 2024

I just wanted to add a sentence of the form : "If you are only interested in the formalization of real numbers, here is the opam directive to install it : " and "if you want to compile from the source here is the make command to apply".

@palmskog
Copy link
Member Author

palmskog commented Nov 14, 2024

Can we keep a meta.yml? My understanding was that this only supports single packages (hence the fact we don't use it in mathcomp).

meta.yml is used for much more than just packages. Indeed we can't currently define/generate packaging boilerplate for monorepo projects with multiple packages, but this doesn't prevent using it for README.md and so on.

@palmskog
Copy link
Member Author

@ybertot see a201fda - does this fit what you had in mind?

@ybertot ybertot merged commit 1739214 into master Nov 14, 2024
19 checks passed
@palmskog palmskog deleted the reals branch November 14, 2024 15:29
@ybertot
Copy link
Collaborator

ybertot commented Nov 14, 2024

@palmskog and @proux01, thank you for your time.

@palmskog
Copy link
Member Author

@ybertot to help out Frédéric Blanqui, there still needs to be a release and corresponding opam packages. I can help out if you want (e.g., I can add packages based on a tag).

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