On Jan 10, 2017 15:17, "Adam Miller" <maxamillion@xxxxxxxxxxxxxxxxx> wrote:
On Tue, Jan 10, 2017 at 1:47 PM, Josh Berkus <jberkus@xxxxxxxxxx> wrote:+1 - I like that idea, makes it very clear to the user.
> On 01/10/2017 10:52 AM, Matthew Miller wrote:
>> On Tue, Jan 10, 2017 at 10:44:03AM -0800, Josh Berkus wrote:
>>>> On Tue, Jan 10, 2017 at 10:33:05AM -0800, Josh Berkus wrote:
>>>>>> USAGE: single command line giving usage example
>>>>>> for invoking the container; will be "N/A" for
>>>>>> some containers.
>>>>
>>>> Why N/A? What circumstances would this be?
>>> CNI Networking container for Kubernetes, for example. A bunch of
>>> "infra" containers only get invoked by other containers and/or the
>>> orchestration system.
>>
>> Could we develop standard wording for that? Like
>>
>> USAGE: Invoked by $OTHERCONTAINER
>>
>> or
>>
>> USAGE: Invoked by Kubernetes when $WHATEVERTRIGGERS
>>
>> or are there too many possibilities?
>
> I don't think there are. I'd suggest:
>
> ---------------
>
> USAGE: Invoked by $SOMEPROCESS. Not for direct use.
>
> "$SOMEPROCESS" should be the name of the infrastructure tool, container,
> or other utility which consumes this container.
>
> ---------------
>
-AdamM
I disagree that the usage should be limited to "used by another container". Even though that is the intended use, the usage description should be uniform and state what capability or function is provided.
Actual usage pattern for code is always more interesting than intended use.
_______________________________________________ cloud mailing list -- cloud@xxxxxxxxxxxxxxxxxxxxxxx To unsubscribe send an email to cloud-leave@xxxxxxxxxxxxxxxxxxxxxxx
