[lxc-devel] [PATCHES] add "--mask-tmp" to lxc-fedora, plus some template script fixes

[Stéphane Graber]

On Tue, Jan 13, 2015 at 02:49:22PM +0000, Serge Hallyn wrote:
> Quoting Michael Adam (obnox at samba.org):
> > On 2015-01-10 at 15:59 +0000, Serge Hallyn wrote:
> > > Quoting Michael Adam (obnox at samba.org):
> > > > On 2015-01-10 at 04:05 +0000, Serge Hallyn wrote:
> > > > > 
> > > > > Actually a patch to remove '-p|--path' from the
> > > > > help statement in all other templates would be appreciated.
> > > > 
> > > > Ok, I was just about to send such an add-on patchset,
> > > > but first one more thought:
> > > > 
> > > > Doesn't the same apply to the -n|--name parameter?
> > > > 
> > > > And what about the --rootfs switch that some
> > > > of the templates (like archlinux) take?
> > > 
> > > Yup, good point, I think it does.
> > 
> > So then, there are two different approaches:
> > 
> > 1) document all options for the sake of completeness,
> >    marking some of them as "intended for internal use only"
> > 
> > 2) hide those internal options from the usage text.
> > 
> > I am personally not 100% certain what I would favour, but
> > slightly inclining towards option 1.
> > 
> > I am happy to do patches for either variant, but will
> > wait for more comments on that first.
> 
> Does anyone else have any opinion?
> 
> I guess I'd favor having them show up at the bottom of the
> template's usage() statement, prefaced by
> 
> For internal use only (do not pass to lxc-create):

When I wrote the download template, I added them to the usage but in a
separate section:

"""
LXC internal arguments (do not pass manually!):
[ --name <name> ]: The container name
[ --path <path> ]: The path to the container
[ --rootfs <rootfs> ]: The path to the container's rootfs
[ --mapped-uid <map> ]: A uid map (user namespaces)
[ --mapped-gid <map> ]: A gid map (user namespaces)
"""

Complete download template usage is:

"""
LXC container image downloader

Required arguments:
[ -d | --dist <distribution> ]: The name of the distribution
[ -r | --release <release> ]: Release name/version
[ -a | --arch <architecture> ]: Architecture of the container

Optional arguments:
[ -h | --help ]: This help message
[ -l | --list ]: List all available images
[ --variant <variant> ]: Variant of the image (default: "default")
[ --server <server> ]: Image server (default: "images.linuxcontainers.org")
[ --keyid <keyid> ]: GPG keyid (default: 0x...)
[ --keyserver <keyserver> ]: GPG keyserver to use
[ --no-validate ]: Disable GPG validation (not recommended)
[ --flush-cache ]: Flush the local copy (if present)
[ --force-cache ]; Force the use of the local copy even if expired

LXC internal arguments (do not pass manually!):
[ --name <name> ]: The container name
[ --path <path> ]: The path to the container
[ --rootfs <rootfs> ]: The path to the container's rootfs
[ --mapped-uid <map> ]: A uid map (user namespaces)
[ --mapped-gid <map> ]: A gid map (user namespaces)
"""

Maybe something like that would work for the other templates too?

-- 
Stéphane Graber
Ubuntu developer
http://www.ubuntu.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: Digital signature
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20150113/2e244d84/attachment.sig>