[PUP-6094] {{puppet -h|--help}} should be equivalent to {{puppet help}} Created: 2016/03/24  Updated: 2017/02/16  Resolved: 2016/07/14

Status: Closed
Project: Puppet
Component/s: None
Affects Version/s: None
Fix Version/s: PUP 4.6.0

Type: Improvement Priority: Normal
Reporter: Michael Smith Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: Help flag consistency
Story Points: 1
Sprint: Client 2016-07-27
Release Notes: Bug Fix
Release Notes Summary: fixed slight differences between the output of `puppet --help` and `puppet help`


This isn't looking to replace puppet help as a face to get help for all sub-commands. The intention is to allow users to use puppet --help to get the same output as puppet help (no arguments). If they want subcommand help, the idea would be to use puppet <subcommand> --help.

Comment by Josh Cooper [ 2016/06/21 ]

I just ran into this myself. I think this is easy to fix.

Comment by Michael Smith [ 2016/06/27 ]

Lori Landesman any consideration that we might want to take advantage of this discrepancy in Puppet to introduce new help output? I guess I'm on the side of avoiding too many variations on similar behavior, so I'd rather have puppet help and puppet --help do the same thing.

Comment by Lori Landesman [ 2016/06/28 ]

Michael Smith I definitely would have both commands do the same thing so that we support users who are used to the current way and accommodate newer ones who would benefit from the consistency across tools. I agree with you that it's too complex to have different kinds of help and force users to try to remember which help does what.

Comment by Eric Thompson [ 2016/07/14 ]

validated on ubuntu1604 at puppet-agent master SHA: 8ae9f84f8da7abe37d4c68f816677306814b164c

root@u4w9tscddf5tsxe:~# puppet --help > dashdash
root@u4w9tscddf5tsxe:~# puppet help > face
root@u4w9tscddf5tsxe:~# diff dashdash face

Generated at Sun Jul 12 23:02:05 PDT 2020 using Jira 8.5.2#805002-sha1:a66f9354b9e12ac788984e5d84669c903a370049.