feat: create an alias from pkg to package #10858
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maiste
force-pushed
the
feat/change-naming
branch
from
7b94d4a to
5986294
Compare
christinerose
approved these changes
Aug 29, 2024
maiste
force-pushed
the
feat/change-naming
branch
4 times, most recently
from
5ff3419 to
eabd5d9
Compare
rgrinberg
reviewed
Sep 5, 2024
| @@ -0,0 +1,4 @@ | |||
| The package command is an alias for the pkg command. The test ensures it breaks if | |||
| the package command is not available. | |||
There was a problem hiding this comment.
Is there really a point to this? If you remove the command, doc/dune.inc will already get updated.
There was a problem hiding this comment.
I didn't know if it would be enough to detect a regression. If you think this is enough, I can definitely remove this test 👍
There was a problem hiding this comment.
It should be enough. If you remove any command, the doc file gets updated. So yeah, I think you can safely drop this test.
There was a problem hiding this comment.
I have reverted the change.
maiste
force-pushed
the
feat/change-naming
branch
2 times, most recently
from
d763801 to
1c3f230
Compare
bin/pkg/pkg.ml
Outdated
| Cmd.info "pkg" ~doc ~man | ||
| let man = | ||
| [ `S "DESCRIPTION" | ||
| ; `P {|Commands for doing package management with dune|} |
There was a problem hiding this comment.
Maybe "Commands for OCaml package management"
There was a problem hiding this comment.
I just extract the code, but I can modify that 😉
christinerose
approved these changes
Sep 5, 2024
Signed-off-by: Etienne Marais <[email protected]>
Signed-off-by: Etienne Marais <[email protected]>
maiste
force-pushed
the
feat/change-naming
branch
from
1c3f230 to
9d9eaba
Compare
anmonteiro
pushed a commit
to anmonteiro/dune
that referenced
this pull request
Nov 17, 2024
* feat: create an alias from pkg to package Signed-off-by: Etienne Marais <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From the interviews conducted by @leostera it appears that, intuitively, people tend to write
packageinstead ofpkg. To respond to this, I have added adune packagecommand, with the same sub commands asdune pkgand a test to make sure we keep track of both.It doesn't seem that Cmdliner provides a way to do aliases, so I had to introduce a new command.