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

Include information about --version option in choco help documentation #2049

Closed
ferventcoder opened this issue May 16, 2020 · 9 comments
Closed

Include information about --version option in choco help documentation #2049

ferventcoder opened this issue May 16, 2020 · 9 comments
Labels
5 - Released Documentation Hacktoberfest Improvement Priority_LOW
Milestone
0.11.0

Comments

@ferventcoder
Copy link
Member

Ensure when running the top level help that --version is mentioned as an option for outputting the version information.

Reference: https://twitter.com/hunterz0/status/1261487482006315018?s=21
@ferventcoder ferventcoder added this to the 0.10.16 milestone May 16, 2020
@gep13
Copy link
Member

gep13 commented Oct 1, 2020

@ferventcoder it looks like @entvex is interested in helping with this issue. Can you please provide a little bit more information about exactly what you were thinking here?

Is it an additional option here:

https://github.com/chocolatey/choco/blob/master/src/chocolatey/infrastructure.app/builders/ConfigurationBuilder.cs#L422-L424

Or were you thinking of something else?

@ferventcoder
Copy link
Member Author

No, unfortunately it is not something that would go top level, it would literally be added after the fact of those items.

@ferventcoder
Copy link
Member Author

So basically something that would be noted in the help menu, but not part of adding it to options.

@GankousKhan
Copy link
Contributor

@ferventcoder I am having some trouble understanding what you mean here at first you say

Ensure when running the top level help that --version is mentioned as an option for outputting the version information

but then later

No, unfortunately it is not something that would go top level, it would literally be added after the fact of those items.

Do you mean to say it would be an entry that would appear after the last switch/option after using the command choco -? which would be

 choco -?
This is a listing of all of the different things you can pass to choco.

Commands
...

Default Options and Switches
...
--log-file=VALUE
     Log File to output to in addition to regular loggers. Available in 0.1-
       0.8+.

The --version switch can be used to determine the current version of your choco installation.

Chocolatey v0.10.15

Where the second from last line The --version switch can be used to determine the current version of your choco installation. was an example addition that:

would literally be added after the fact of those items.

Or if there is preferred verbiage and or formatting other than what I have noted please mention.

@DeeHechEss DeeHechEss mentioned this issue Oct 2, 2020
Closed
@entvex
Copy link

entvex commented Oct 12, 2020 •
edited
Loading

As we talked about on gitter.im, I would like to help solve this issue.
@ferventcoder said in this issue that it should not be part of the options, but that is exactly what the PR from DeeHechEss do.
So i wonder if you have any plan on how you like this implemented ?

@gep13
Copy link
Member

gep13 commented Apr 19, 2021

@ferventcoder as mentioned, I think more guidance is required here on exactly where this change should be made. I don't believe that the current open PR addresses it in the correct location. Thoughts?

@entvex
Copy link

entvex commented May 10, 2021 •
edited
Loading

@ferventcoder @gep13 if more guidance, is provided, I would like to help solve this :)

@ferventcoder
Copy link
Member Author

ferventcoder commented May 11, 2021 •
edited
Loading

I think originally I just wanted it to be added as a note in choco -?, not something that would actually be added to the options, for the reason I mentioned on PR #2129.

gep13 added a commit that referenced this issue May 12, 2021
@gep13 @DeeHechEss
(#2049) Add version option to help text
e8f76b6 
Provide information about the ability to use the -v, and --version,
options on the top level choco command to print out information about
the current Chocolatey version.

Co-authored-by: DeeHechEss <[email protected]>
@gep13
Copy link
Member

gep13 commented May 12, 2021

This has been added, and now show this in the output of the help command:

image

@gep13 gep13 closed this as completed May 12, 2021
gep13 added a commit that referenced this issue May 13, 2021
@gep13
(#2049) Add --version to top level tab expansion
0544f28 
Running choco --version reports the currently installed Chocolatey
version number, but this option wasn't included in the tab expansion
options for the top level choco command, this change adds this in.
gep13 added a commit that referenced this issue May 13, 2021
@gep13
Merge branch 'stable' into master
af3e8c9 
* stable: (44 commits)
  (#2220) Add convert command to allowed list
  (#2049) Add --version to top level tab expansion
  (#944) Add tab expansion for help command
  (#357) Add tab expansion for export command
  (#357) Ensure to use full file path
  (maint) fix typo
  (maint) formatting
  (doc) pin: show reasons option
  (maint) log message on nuget conflict
  (#2270) Update to NuGet.exe 5.9.1.11
  (#2049) Add version option to help text
  (#2112) Add msp support to Install helper
  (maint) Change formatting
  (maint) Switch to using a Regex match
  (#2244) Add badge for latest docker semver version
  (#2244) Add status badge for GitHub Action
  (#2261) Minor tweak to remove extra space
  (#2261) Updates License Headers Copyright to 2021
  (#2263) Pack on Mono pass absolute path to PackageBuilder
  (#2244) Add Docker build into main workflow
  ...
@gep13 gep13 changed the title Choco -? Should note --version as a switch Include information about --version option in choco help documentation May 18, 2021
@TheCakeIsNaOH TheCakeIsNaOH mentioned this issue Jan 20, 2022
Closed
tapika added a commit to tapika/swupd that referenced this issue Mar 11, 2022
@tapika
Copy from choco/develop, Add help command chocolatey#944, chocolatey#…
8d3c2ee 
…2231, chocolatey#2261, chocolatey#2049, chocolatey#2641, chocolatey#2641
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
5 - Released Documentation Hacktoberfest Improvement Priority_LOW
Projects
None yet
Milestone
0.11.0
Development

Successfully merging a pull request may close this issue.

(#2049) Note --version as a switch in the help menu DeeHechEss/choco
4 participants
@ferventcoder @gep13 @entvex @GankousKhan