doc: better define job, service & task
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
upstart |
Triaged
|
Low
|
Unassigned | ||
upstart (Ubuntu) |
Triaged
|
Low
|
James Hunt |
Bug Description
Binary package hint: upstart
Description: Ubuntu 9.10
Release: 9.10
man 5 init says:
Each file defines a single service or task, with the name taken from
its relative path within the directory without the extension. For
example a job defined in /etc/init/
while a job defined in /etc/init/
It is, perhaps, a small point, but I wonder whether "service", "task" and "job" are three terms for the same thing or whether they are three different things, somehow all related to the the files in the /etc/init directory in ways yet to be defined. If they are all the same it would be helpful to say so, then choose one term and use it consistently. If they are different things and important enough to bring up in the third paragraph of the description, then they should be better defined and distinguished.
I would offer a rewrite, but I don't know what is correct. I find the following, taken from http://
Jobs are defined in files placed in /etc/init, the name of the job is the
filename under this directory without the .conf extension.
But I suspect it would be as correct and less ambiguous to say:
Jobs are defined by files in /etc/init. Each file defines a single job.
The name of the job is the filename under this directory without
the .conf extension.
Cheers,
Ian
summary: |
- inconsistent terminology in man 5 init + doc: better define job, service & task |
Changed in upstart: | |
status: | New → Triaged |
importance: | Undecided → Low |
Changed in upstart (Ubuntu): | |
assignee: | nobody → James Hunt (jamesodhunt) |
Putting the last and first examples together with a guess, maybe the paragraph would be better if it were changed to:
Each file defines a single job. The name of the job is the filename under
/etc/init/ rc-sysinit. conf is named rc-sysinit, while a job defined in
/etc/init/ net/apache. conf is named net/apache. The terms service and
this directory without the .conf extension. For example a job defined in
task are also used. These are synonyms for job.