Bug 435056

Summary: needs better docs
Product: [Fedora] Fedora Reporter: Bill Nottingham <notting>
Component: upstartAssignee: Casey Dahlin <cdahlin>
Status: CLOSED DUPLICATE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: low Docs Contact:
Priority: low    
Version: rawhideCC: notting, rvokal, scott, vanhoof
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-04-05 00:30:43 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Bill Nottingham 2008-02-27 02:01:29 UTC
Description of problem:

Well, so does everything, I suppose. However, the sum total of docs on event
writing that I can find are:

http://upstart.ubuntu.com/getting-started.html
http://upstart.ubuntu.com/wiki/Stanzas

neither of which is remotely close to comprehensive. There's a lot of other
stuff on the wiki, but as it's all in-development specs, it's not particularly
useful.

Version-Release number of selected component (if applicable):

upstart-0.3.9-5.fc9.x86_64

Comment 1 Casey Dahlin 2008-02-27 02:34:09 UTC
What's the delivery mechanism we want to use? Just drop stuff in the docs folder?

The Manpages do a pretty good job of describing the commands and the general
workings, its just the job definitions where information is sparse (even I'm not
certain what all is available). We could add a man event.d page that explained
these.

Comment 2 Bill Nottingham 2008-02-27 02:51:11 UTC
The event definition stuff is what I'm missing; there seems to be a lack of
anything that describes how to write non-trivial events. For example, our prefdm
script has:

stop on runlevel [!5]

but I'm unable to find anything that describes that syntax, or what other
globbing/operators may be available, or variable substitutions, etc.

Comment 3 Casey Dahlin 2008-02-27 02:56:42 UTC
That only got written because Scott wrote it :)

We'll need him in on this methinks.

Comment 4 Scott James Remnant 2008-02-27 10:12:42 UTC
Part of the reason that there's not much documentation on the job definition
format is that it's been subject to change, and I didn't want people relying on
anything more than the basic features documented on getting-started (even those
changed with 0.3! :p)

Documentation will be coming though, as soon somebody (me probably :-/) sits
down and writes it -- code comes first tho :p

For the record, the globbing is done with fnmatch() so follows glob(7) rules

Comment 5 Bill Nottingham 2008-04-05 00:30:43 UTC

*** This bug has been marked as a duplicate of 439245 ***