Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Documentation refresh. #221
Conversation
elopio
reviewed
Jan 12, 2016
| + snap: | ||
| + - $fswebcam | ||
| + - $go-server | ||
| + - -usr/share/doc |
elopio
reviewed
Jan 12, 2016
| - A set of keys representing binary names with values as defined by the | ||
| - [Snappy packaging spec](https://developer.ubuntu.com/snappy/guides/packaging-format-apps/). | ||
| + * `apps` (yaml subsection) | ||
| + A map of keys for integration points for the system. Either as a daemon |
elopio
Jan 12, 2016
Member
"integration points for the system" says nothing to me. Do we have a better way to tell what's an app?
elopio
reviewed
Jan 12, 2016
| + A map of keys for integration points for the system. Either as a daemon | ||
| + or command line accessible binary. | ||
| + * `command` (string) | ||
| + Specifies the internal command to expose. |
elopio
reviewed
Jan 12, 2016
| + Specifies the internal command to expose. | ||
| + * `daemon` (string) | ||
| + If present, integrates the runnable as a system service. Valid values are | ||
| + forking and simple. |
elopio
reviewed
Jan 12, 2016
| + forking and simple. | ||
| + * `stop-command` (string) | ||
| + Requires `daemon` to be specified and represents the command to run to | ||
| + effectively stop the service. |
elopio
Jan 12, 2016
Member
"effectively" seems to serve no purpose here. The sentence says the same if you remove it.
elopio
reviewed
Jan 12, 2016
| + Requires `daemon` to be specified and represents the command to run to | ||
| + effectively stop the service. | ||
| + * `stop-timeout` (integer) | ||
| + Requires `daemon` to be specified. It is number in seconds to indicate how |
elopio
Jan 12, 2016
Member
It is number of seconds that the system will wait for the service to stop.
I'm not sure if this sounds better, so @kyrofa please.
elopio
reviewed
Jan 12, 2016
| + Path to a license file. | ||
| + * `license-agreement` (string) | ||
| + Requires `license` to be set. The only valid value for this entry is | ||
| + `explicit` stating that if a license is present, acceptance to it must |
elopio
Jan 12, 2016
Member
What about: stating that if a license is present, the user must accept it in order to install the snap.
elopio
reviewed
Jan 12, 2016
| + require an explicit action. | ||
| + A good example for this one is the Sun JRE/JDK being bundled in a snap. | ||
| + * `license-version` (string) | ||
| + Requires `license` to be set. Effectively the version for the license. |
|
I summon also @dholbach. |
kyrofa
reviewed
Jan 12, 2016
| + stop the service. | ||
| + * `stop-timeout` (integer) | ||
| + Requires `daemon` to be specified. It is number in seconds that the | ||
| + system will wait for the service to stop. |
kyrofa
Jan 12, 2016
Member
Sounds threatening. Should we specify what happens if the daemon takes too long to stop?
sergiusens
Jan 12, 2016
Collaborator
I don't know how to change reality :-)
Configures the time to wait for stop. If a service is asked to stop, but does not terminate in the specified time, it will be terminated forcibly via SIGTERM, and after another timeout of equal duration with SIGKILL (see KillMode= in systemd.kill(5)). Takes a unit-less value in seconds, or a time span value such as "5min 20s". Pass "0" to disable the timeout logic. Defaults to DefaultTimeoutStopSec= from the manager configuration file (see systemd-system.conf(5)).
Unless we disable the possibility of allowing 0
kyrofa
Jan 12, 2016
Member
Do we pass this straight to systemd? Heck, we might as well include almost that entire text. How about changing this to:
Requires `daemon` to be specified. It is the length of time that the system
will wait for the service to stop before terminating it via SIGTERM (and
SIGKILL if that doesn't work). Accepts a unit-less value in seconds, or a
time span value such as "5min 20s." A value of 0 indicates that the system
should wait forever for the service to stop.
kyrofa
Jan 12, 2016
Member
Oh wait-- it's an integer. Okay, how about this:
Requires `daemon` to be specified. It is the length of time in seconds that the
system will wait for the service to stop before terminating it via SIGTERM (and
SIGKILL if that doesn't work).
sergiusens
Jan 12, 2016
Collaborator
This sounds sensible, we might be removing the 0 or disallow it so this is good
kyrofa
reviewed
Jan 12, 2016
| + * `license-agreement` (string) | ||
| + Requires `license` to be set. The only valid value for this entry is | ||
| + `explicit` which requires the license to be accepted for the snap to | ||
| + install. |
added a commit
that referenced
this pull request
Jan 12, 2016
sergiusens
merged commit 08d274a
into
snapcore:master
Jan 12, 2016
sergiusens
deleted the
sergiusens:doc-update
branch
Jan 12, 2016
pushed a commit
to smoser/snapcraft
that referenced
this pull request
Sep 14, 2016
pushed a commit
to smoser/snapcraft
that referenced
this pull request
Sep 14, 2016
pushed a commit
to kalikiana/snapcraft
that referenced
this pull request
Apr 6, 2017
sergiusens commentedJan 12, 2016
Refreshing the docs refering to yaml keywords and lifecycle changes affecting
2.0
LP: #1533021