Re: Proposal: require DESCRIPTION, USAGE label for images

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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.

---------------

-- 
--
Josh Berkus
Project Atomic
Red Hat OSAS
_______________________________________________
cloud mailing list -- cloud@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to cloud-leave@xxxxxxxxxxxxxxxxxxxxxxx




[Index of Archives]     [Fedora General Discussion]     [Older Fedora Users Archive]     [Fedora Advisory Board]     [Fedora Security]     [Fedora Devel Java]     [Fedora Legacy]     [Fedora Desktop]     [ATA RAID]     [Fedora Marketing]     [Fedora Mentors]     [Fedora Package Announce]     [Fedora Package Review]     [Fedora Music]     [Fedora Packaging]     [Centos]     [Fedora SELinux]     [Coolkey]     [Yum Users]     [Big List of Linux Books]     [Yosemite News]     [Linux Apps]     [KDE Users]     [Fedora Art]     [Fedora Docs]     [Asterisk PBX]

  Powered by Linux