alire icon indicating copy to clipboard operation
alire copied to clipboard

documentation of alr toolchain --uninstall misses argument

Open pjljvandelaar opened this issue 2 years ago • 2 comments

I have installed alr

PS C:\path\to\Rejuvenation-Ada\workshop\tests> alr version
Alr version: 1.1.2
Alire Library version: 1.1.2
alr status is (valid) (0 releases indexed) (loaded in 0.675s)
config folder is C:\Users\nx011987\.config\alire
source folder is C:\Users\nx011987\.config\alire\alire
interaction flags are: force:FALSE not-interactive:FALSE
alr root is empty
alr root detection has settled on path: C:\path\to\Rejuvenation-Ada\workshop\tests
alr is finding 1 GPR project files
alr session state is [OUTSIDE]
alr compiled on [2022-01-27 13:44:56] with GNAT version [Community 2021 (20210519-103)]
platform fingerprint: Windows Bits_64 Msys2
platform properties: MSYS2 WINDOWS NATIVE USER BITS_64
community index required branch: stable-1.1

When I call alr as follows alr help toolchain

I get

SUMMARY
   Manage Alire-provided toolchains

USAGE
   alr toolchain [options] [-u|--uninstall] [-i|--install crate[version set]] | --select [--local] [releases] [--disable-assistant]

...

However, both the install and uninstall flags should be passed a crate with optional version set. So I had expected something like alr toolchain [options] [-u|--uninstall|-i|--install crate[version set]] | --select [--local] [releases] [--disable-assistant] or alr toolchain [options] [-u|--uninstall crate[version set]] | [-i|--install crate[version set]] | --select [--local] [releases] [--disable-assistant]

pjljvandelaar avatar Apr 12 '22 14:04 pjljvandelaar

Good catch, thanks for the report.

mosteo avatar Apr 12 '22 16:04 mosteo

I still wonder if we should keep the toolchain install/uninstall feature in. It's a convenient way to install the toolchains built for the Alire project, but it doesn't fit in the Alire workflow, and would be better replaced by a GitHub action...

Fabien-Chouteau avatar Apr 13 '22 08:04 Fabien-Chouteau