Skip to content

doc: mention the compare-versions command in the manual#6596

Merged
kit-ty-kate merged 2 commits intoocaml:masterfrom
mbarbin:doc-compare-versions
Aug 11, 2025
Merged

doc: mention the compare-versions command in the manual#6596
kit-ty-kate merged 2 commits intoocaml:masterfrom
mbarbin:doc-compare-versions

Conversation

@mbarbin
Copy link
Copy Markdown
Contributor

@mbarbin mbarbin commented Jul 13, 2025

Add a mention of the opam admin compare-versions command in the manual.

This is a continuation of #6197 to improve discoverability (small qol).

Thanks!

mbarbin added 2 commits July 13, 2025 21:55
@mbarbin
doc: mention the compare-versions command in the manual
9c63f7a 
Signed-off-by: Mathieu Barbin <mathieu.barbin@gmail.com>
@mbarbin
Add changelog entry
c490c4a 
Signed-off-by: Mathieu Barbin <mathieu.barbin@gmail.com>
@kit-ty-kate
Copy link
Copy Markdown
Member

kit-ty-kate commented Jul 14, 2025

lgtm, we could even simplify the section by removing the previous method which uses OpamVersionCompare, but maybe we should keep it for now until most people actually use opam 2.4.

We'll have a second look and probably merge it tomorrow. Thanks!

@kit-ty-kate kit-ty-kate added this to the 2.5.0~alpha1 milestone Jul 14, 2025
@mbarbin
Copy link
Copy Markdown
Contributor Author

mbarbin commented Jul 28, 2025

we could even simplify the section by removing the previous method which uses OpamVersionCompare,

Agreed!

but maybe we should keep it for now until most people actually use opam 2.4.

Agreed!

So in summary, Agreed on all accounts 😃 . Thanks a lot for the review!

@rjbou
Copy link
Copy Markdown
Collaborator

rjbou commented Jul 28, 2025 •
edited
Loading

The PR is good. It is hold up opam2web manpage & api generaion job fixup.

rjbou
rjbou reviewed Jul 28, 2025
View reviewed changes
doc/pages/Manual.md
[0]
```

Refer to the command help page for more details.
Copy link
Copy Markdown
Collaborator

@rjbou rjbou Jul 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

todo for opam devs: Add a link to api compare_version function

@kit-ty-kate kit-ty-kate mentioned this pull request Aug 11, 2025
Open
kit-ty-kate
kit-ty-kate approved these changes Aug 11, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@kit-ty-kate kit-ty-kate left a comment

Choose a reason for hiding this comment

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

Improvement of the API section will be done separately. See #6637

@kit-ty-kate
Copy link
Copy Markdown
Member

kit-ty-kate commented Aug 11, 2025

Thanks a lot!

@kit-ty-kate kit-ty-kate merged commit a720c5f into ocaml:master Aug 11, 2025
2 checks passed
@mbarbin
Copy link
Copy Markdown
Contributor Author

mbarbin commented Aug 11, 2025

Thank you!

@mbarbin mbarbin deleted the doc-compare-versions branch August 11, 2025 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rjbou rjbou rjbou left review comments

@kit-ty-kate kit-ty-kate kit-ty-kate approved these changes

Assignees

No one assigned

Labels

AREA: DOCUMENTATION

Projects

None yet

Milestone

2.5.0~alpha1

Development

Successfully merging this pull request may close these issues.

3 participants

@mbarbin @kit-ty-kate @rjbou