Man page improvement - lxc.start.order


#1

Having looked into https://linuxcontainers.org/lxc/manpages/man5/lxc.container.conf.5.html

lxc.start.order
An integer used to sort the containers when auto-starting a series of containers at once.

AUTOSTART AND SYSTEM BOOT
... The startup will be in order of lxc.start.order.

The leaves one to guesswork of how the integer is interpreted, e.g. whether 0 is lowest or highest priority or even whether 0 might be a special value (like perhaps disabling)

It thus requires a (potential) user to sour other sources (e.g. https://stgraber.org/2013/12/21/lxc-1-0-your-second-container/) to discover

priority of the container, higher value means starts earlier

I suppose such should be rather pointed out in the man pages.


#2

I would have guessed that lower number starts earlier.
Are you familiar with git, GitHub, in order to create a pull request with a clarification?


#3

My sentiments exactly, my logic would also have been that 0 is either the highest priority, or if representing a special value such as disable for instance than 1 being the highest priority and incrementing integer’s value is decreasing the priority but apparently it is the other way around.

Not sure if it warrants a clarification on Github really but rather a more expansive explanation at the man page. Have updated the previous post with the source of the information, being a blog of @stgraber.

Unless this changed over time from lxc 1, which the blog post from 2013 is based on, to today’s lxc 3 version


#4

I am on mobile now. As far as I understand, the man pages are on the lxc git repository on GitHub. It should be GitHub.com/lxc/lxc
You can edit the manpage and submit a pull request to accept the change.


#5

Seems not located there. All I could trace https://github.com/lxc/linuxcontainers.org/tree/master/manpages/lxc but there are only placeholders for some languages.


#6

It’s here,

The man pages are created from SGML, which should not be difficult to edit.


#7

Thank you for the pointer! Prior editing though it would be good to know whether an interger of 0 serves a special purpose or is just the lowest priority.


#8

Searching through the source code, shows only the following occurence:

Therefore, the number there is only used to compare between containers. 0 has no special significance.