* command line interface conventions and best practices
@ 2020-02-26 15:56 Brad Bishop
2020-02-26 16:54 ` Patrick Venture
2020-02-26 17:20 ` Patrick Williams
0 siblings, 2 replies; 3+ messages in thread
From: Brad Bishop @ 2020-02-26 15:56 UTC (permalink / raw)
To: OpenBMC Maillist
Does anyone have a favorite reference that outlines de-facto command line
interface conventions and best practices? Things like e.g. long options
should have two dashes, options should not have capital letters, etc?
thanks!
-brad
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: command line interface conventions and best practices
2020-02-26 15:56 command line interface conventions and best practices Brad Bishop
@ 2020-02-26 16:54 ` Patrick Venture
2020-02-26 17:20 ` Patrick Williams
1 sibling, 0 replies; 3+ messages in thread
From: Patrick Venture @ 2020-02-26 16:54 UTC (permalink / raw)
To: Brad Bishop; +Cc: OpenBMC Maillist
On Wed, Feb 26, 2020 at 7:57 AM Brad Bishop <bradleyb@fuzziesquirrel.com> wrote:
>
> Does anyone have a favorite reference that outlines de-facto command line
> interface conventions and best practices? Things like e.g. long options
> should have two dashes, options should not have capital letters, etc?
There has been a push to using cli11 instead of each repo wrapping
getopts, but it's not required.
https://github.com/openbmc/docs/blob/master/anti-patterns.md#custom-argumentparser-object
>
> thanks!
>
> -brad
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: command line interface conventions and best practices
2020-02-26 15:56 command line interface conventions and best practices Brad Bishop
2020-02-26 16:54 ` Patrick Venture
@ 2020-02-26 17:20 ` Patrick Williams
1 sibling, 0 replies; 3+ messages in thread
From: Patrick Williams @ 2020-02-26 17:20 UTC (permalink / raw)
To: Brad Bishop; +Cc: OpenBMC Maillist
[-- Attachment #1: Type: text/plain, Size: 689 bytes --]
On Wed, Feb 26, 2020 at 10:56:54AM -0500, Brad Bishop wrote:
> Does anyone have a favorite reference that outlines de-facto command line
> interface conventions and best practices? Things like e.g. long options
> should have two dashes, options should not have capital letters, etc?
>
> thanks!
>
> -brad
https://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
https://www.gnu.org/prep/standards/html_node/Command_002dLine-Interfaces.html
https://www.gnu.org/software/libc/manual/html_node/Getopt.html
I will say one pet peeve of mine is when a multi-word option is
--long_option but I don't see that discussed in any of these.
--
Patrick Williams
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-02-26 17:20 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-26 15:56 command line interface conventions and best practices Brad Bishop
2020-02-26 16:54 ` Patrick Venture
2020-02-26 17:20 ` Patrick Williams
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.