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.

Sign up for GitHub

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

Jump to bottom

command line args could use some documentation #91

Open
coke opened this issue May 2, 2016 · 2 comments
Open

command line args could use some documentation #91

coke opened this issue May 2, 2016 · 2 comments

Comments

@coke
Copy link
Contributor

coke commented May 2, 2016

The README points to the output of the command, but that doesn't detail what the individual subcommands actually do. It would be nice if we had another markdown file that listed the available options and what they're for.
fluca1978 added a commit to fluca1978/rakudobrew that referenced this issue Oct 7, 2017
@fluca1978
Provide help via POD documentation.
4439a4b 
Fix issue tadzik#91.

The idea is to let the help branch to introspect the POD documentation
for a specific command in order to see if some documentation can be found.
If documentation can be found, it is shown. This allows for:
- invoking help on subcommands, for instance
  rakudobrew help nuke
- invoking help without any argument, that as already done
  simply prints the list of commands
- invoking an alien command, that results in printing out
  the list of available commands.

This requires an explicit dependency on Pod::Usage.

The help is provided as POD documentation with sections named 'COMMAND'
and the name of the command as passed to rakudobrew. The nuke command
has been introduced as an example.
@fluca1978 fluca1978 mentioned this issue Oct 7, 2017
Closed
@RichardJActon
Copy link

Hi, a specific instance of this from the usage message is:

rakudobrew switch jvm|moar|moar-blead

when you install a new version using the form:

rakudobrew build jvm|moar|moar-blead|all [tag|branch|sha-1] [--configure-opts=]

you have to switch to it using something of the form:

rakudobrew switch jvm|moar|moar-blead-[tag|branch|sha-1]

e.g. rakudobrew switch moar-2018.04.1

which is not clear from the documentation of the switch option in usage.

see: https://stackoverflow.com/questions/45464233/multiple-versions-of-perl6-using-rakudobrew?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa

@patrickbkr
Copy link
Collaborator

The default help message has changed a bit. The switch command now at least doesn't give wrong instructions. Also the README.md now gives a one-liner explanation for each command there is.
I'll have a look at PR#125 soon-ish.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@coke @patrickbkr @RichardJActon