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

Coq Platform Readme.md does not point to latest release #322

Open
andrew-appel opened this issue Jan 23, 2023 · 7 comments
Open

Coq Platform Readme.md does not point to latest release #322

andrew-appel opened this issue Jan 23, 2023 · 7 comments
Assignees

Comments

@andrew-appel
Copy link

When I want to install the Coq Platform, I go to the main README.md for instructions, but unfortunately it does not point me to the latest release.

Right now the latest release is 2022.09.1, but the most recent release in the README is 2022.09.

The simplest way to fix this is to delete from the README the long list of specific releases, and say instead: To get the latest release, or any previous release, visit https://github.com/coq/platform/releases

@MSoegtropIMC
Copy link
Collaborator

Sorry, I can't quite follow you. As far as I can see the main ReadMe has a list of supported Coq versions - which is something else than a Coq Platform release. The latest release of Coq Platform supports all these versions of Coq.

The platform specific ReadMe files have a link to https://github.com/coq/platform/releases as you suggest.

Where do you see a link to an old release in one of the readme files?

@andrew-appel
Copy link
Author

This file:
https://github.com/coq/platform/blob/main/README.md
lists 8 different specific Platform releases, none of which is the newest one.

Instead of listing specific releases in that README.md, I suggest pointing to the general "releases" page that's automatically up to date.

@MSoegtropIMC
Copy link
Collaborator

No, this is a list of the Coq versions and package picks supported by the latest version of Coq Platform.

This list is accurate and up to date (e.g. it names Coq 8.16.1, not 8.16.0). The package pick did not change (short of bug fixes like 8.16.0 -> 8.16.1 and compatible changes) since September.

For the top two entries in the list the release provides installers. All other versions can be installed with the scripts.

The point of this is to ensure that one can still build old versions of Coq, e.g for artefact reproduction and for porting. This is not trivial, e.g. there were issues in the OCaml originally used for 8.13 and earlier which make the original 8.13 builds impossible to run on recent Linux. By supporting old Coq versions in latest Coq Platform versions we can test that all this actually works in CI. Specific requests for bug fix back ports in OCaml came from this CI.

@MSoegtropIMC
Copy link
Collaborator

P.S.: since it is obviously unclear what this list is, we should improve the documentation here. Do you have suggestions?

@andrew-appel
Copy link
Author

The main web page for Coq Platform, which is basically the README.md under discussion, should say as prominently and early as possible,

To install the latest Coq Platform release, look here.

@MSoegtropIMC
Copy link
Collaborator

OK, makes sense. We have this via an indirection to the platform specific pages, but for people who know this already it is indeed not ideal. I will change it as you suggest.

@MSoegtropIMC MSoegtropIMC self-assigned this Jul 12, 2024
@MSoegtropIMC MSoegtropIMC added this to the 2024.01-Coq8.19 milestone Jul 12, 2024
@MSoegtropIMC
Copy link
Collaborator

Triage note: should be fixed, but we will retest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants