Merge lp:~jamesodhunt/ubuntu/natty/upstart/proposed-stage2 into lp:ubuntu/natty/upstart

[James Hunt]

* debian/manpages/upstart-events.7:
  - Corrected reference to Upstart man page (actually init).
  - Changed to using proper troff quotes.
  - Escaped dashes in event names.
  - Updated date.
  - Table 1:
    - Improved name.
    - Sorted columns: Events, References, and Notes.
    - Added unmounted-remote-filesystems event.
* init/tests/test_control.c: Added comment.
* scripts/initctl2dot.py: Fixes to handle 'emits' glob syntax:
  - header(): Change default node to be an event to simplify handling
    globs in 'emits' stanzas.
  - footer(): Updated for glob event nodes.
  - sanitize(): Protect against glob syntax.
  - show_event(): Update for glob event nodes.
  - show_job(): Explicit specification of record node.
  - show_edges(): Handle 'emits' glob syntax.

[Colin Watson (cjwatson)]

review: Approve

=== modified file 'ChangeLog'
--- ChangeLog	2011-03-15 16:18:21 +0000
+++ ChangeLog	2011-03-24 16:01:02 +0000
@@ -1,3 +1,15 @@
[phone]  James Hunt  <[e-mail]>
+
+	* init/tests/test_control.c: Added comment.
+	* scripts/initctl2dot.py: Fixes to handle 'emits' glob syntax:
+	  - header(): Change default node to be an event to simplify handling
+	    globs in 'emits' stanzas.
+	  - footer(): Updated for glob event nodes.
+	  - sanitize(): Protect against glob syntax.
+	  - show_event(): Update for glob event nodes.
+	  - show_job(): Explicit specification of record node.
+	  - show_edges(): Handle 'emits' glob syntax.
+
 2011-03-15  James Hunt  <[e-mail]>
 
 	* configure.ac: Bump version to 0.9.3.
 
=== modified file 'NEWS'
--- NEWS	2011-03-15 12:15:28 +0000
+++ NEWS	2011-03-24 16:01:02 +0000
@@ -1,3 +1,8 @@
+0.9.4  2011-03-24
+
+	* scripts/initctl2dot.py: Fix to handle 'emits' glob syntax
+	  which was causing script to fail for upstart-udev-bridge.
+
 0.9.3  2011-03-15
 
 	* Added missing emits stanzas for supplied .conf files.
 
=== modified file 'configure.ac'
--- configure.ac	2011-03-15 12:15:28 +0000
+++ configure.ac	2011-03-24 16:01:02 +0000
@@ -1,7 +1,7 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ(2.61)
-AC_INIT([upstart], [0.9.3], [[e-mail]])
+AC_INIT([upstart], [0.9.4], [[e-mail]])
 NIH_COPYRIGHT([[Copyright © 2011 Canonical Ltd.]])
 AC_CONFIG_SRCDIR([init/main.c])
 AC_CONFIG_MACRO_DIR([m4])
 
=== modified file 'debian/changelog'
--- debian/changelog	2011-03-15 12:15:28 +0000
+++ debian/changelog	2011-03-24 16:01:02 +0000
@@ -1,3 +1,24 @@
+upstart (0.9.4-1ubuntu1) natty; urgency=low
+
+  * debian/manpages/upstart-events.7:
+    - Corrected reference to Upstart man page (actually init).
+    - Changed to using proper troff quotes.
+    - Escaped dashes in event names.
+    - Updated date.
+    - Table 1:
+      - Improved name.
+      - Sorted columns: Events, References, and Notes.
+      - Added unmounted-remote-filesystems event. 
+
+ -- James Hunt <[e-mail]>  Thu, 24 Mar 2011 14:34:12 +0000
+
+upstart (0.9.4-1) natty; urgency=low
+
+  * New upstream release 0.9.4:
+    - scripts/initctl2dot.py: Fixes to handle 'emits' glob syntax.
+
+ -- James Hunt <[e-mail]>  Thu, 24 Mar 2011 14:31:26 +0000
+
 upstart (0.9.3-1) natty; urgency=low
 
   * New upstream release 0.9.3:
 
=== modified file 'debian/manpages/upstart-events.7'
--- debian/manpages/upstart-events.7	2011-03-04 17:17:18 +0000
+++ debian/manpages/upstart-events.7	2011-03-24 16:01:02 +0000
@@ -1,14 +1,16 @@
 '\" t
-.TH upstart-events 7 2011-03-04 "Upstart-Events"
+.TH upstart-events 7 2011-03-24 upstart
 .\"
 .SH NAME
 upstart-events \- Well-known Upstart events summary
 .\"
 .SH Event Summary
 
-This manual page summarizes well-known \fBUpstart\fP(8) events. It is
-not an exhaustive list of all possible events, but rather details a
-standard set of events expected to be generated on any Ubuntu system
+This manual page summarizes well-known events generated by the Upstart
+.BR init (8)
+daemon.
+It is not an exhaustive list of all possible events, but rather details
+a standard set of events expected to be generated on any Ubuntu system
 running Upstart.
 
 The primary table, \fBTable 1\fP, encodes the well-known events, along
@@ -20,11 +22,11 @@
 The \fIRef\fP (Reference) column is used to refer to individual
 events succinctly in the \fITime\fP column.
 
-Note that the \'<\' and \'>\' characters in the \fITime\fP column denote
+Note that the \(aq<\(aq and \(aq>\(aq characters in the \fITime\fP column denote
 that the event in the \fIEvent\fP column occurs respectively before or
 after the event specified in the \fITime\fP column (for example, the
 \fBmounting\fP(7) event occurs "at some time" after the \fBstartup\fP(7)
-event, and the \fBvirtual-filesystems\fP(7) event occurs after the last
+event, and the \fBvirtual\-filesystems\fP(7) event occurs after the last
 \fBmounted\fP(7) event relating to a virtual filesystem has been emitted).
 
 For further details on events, consult the manual pages and the job
@@ -38,47 +40,52 @@
 .po 0
 .in 0
 .sp 1
-\fBTable 1: Event Summary.\fP
+\fBTable 1: Well-Known Event Summary.\fP
 .TS
 box, tab (@);
 c | c | c | c | c | c
 c | l | c | c | l | c.
 Ref@Event@Type@Emit@Time@Note
 =
-1@\fBstartup\fP(7)@S@I@Boot@A
-2@\fBmounting\fP(7)@H@M@> (1)@B
-3@\fBmounted\fP(7)@H@M@> associated (2)@C
-4@\fBvirtual-filesystems\fP(7)@S@M@> last virtual FS (3)@D
-  @\fBlocal-filesystems\fP(7)@S@M@> (4)@
-  @\fBremote-filesystems\fP(7)@S@M@> (4)@
-  @\fBfilesystem\fP@S@M@After last (3)@E
-  @\fBall-swaps\fP@S@M@> (1)@
-  @\fBcontrol-alt-delete\fP(7)@S@A@> (1)@F
-  @\fBkeyboard-request\fP(7)@S@A@> (1)@G
-  @\fBpower-status-changed\fP(7)@S@I@> (1)@H
-  @\fBrunlevel\fP(7)@M@T@> (1)@
-  @login-session-start@H@D@< DM running@I
-  @desktop-session-start@H@D@> \fBX\fP(7) session created@J
-5@net-device-added@S@U@> (1)@K
-  @net-device-changed@S@U@> (1)@K
-6@net-device-removed@S@U@> (1)@K
-  @net-device-up@S@F,N@> (5)@K
-  @net-device-down@S@F@< (6)@K
-  @drm-device-added@S@U@> (1)@K
-  @graphics-device-added@S@U@> (1)@K
-  @\fBstarting\fP(7)@H@I@< job starts@L
-  @\fBstarted\fP(7)@S@I@> job started@L
-  @\fBstopping\fP(7)@H@I@< job stops@L
-  @\fBstopped\fP(7)@S@I@> job stopped@L
-  @\fBsocket\fP(7)@S@I@> socket connection@
-  @dbus-activation@S@B@> D-Bus client request@
+  @\fBall\-swaps\fP@S@M@> (5)@
+  @\fBcontrol\-alt\-delete\fP(7)@S@A@> (5)@A
+  @dbus\-activation@S@B@> D\-Bus client request@
+  @desktop\-session\-start@H@D@> \fBX\fP(7) session created@B
+  @drm\-device\-added@S@U@> (5)@C
+  @\fBfilesystem\fP@S@M@After last (1)@D
+  @graphics\-device\-added@S@U@> (5)@C
+  @\fBkeyboard\-request\fP(7)@S@A@> (5)@E
+  @\fBlocal\-filesystems\fP(7)@S@M@> (6)@
+  @login\-session\-start@H@D@< DM running@F
+1@\fBmounted\fP(7)@H@M@> associated (2)@G
+2@\fBmounting\fP(7)@H@M@> (5)@H
+3@net\-device\-added@S@U@> (5)@C
+  @net\-device\-changed@S@U@> (5)@C
+  @net\-device\-down@S@F@< (4)@C
+4@net\-device\-removed@S@U@> (5)@C
+  @net\-device\-up@S@F,N@> (3)@C
+  @\fBpower\-\%status\-\%changed\fP(7)@S@I@> (5)@I
+  @\fBremote\-\%filesystems\fP(7)@S@M@> (6)@
+  @\fBrunlevel\fP(7)@M@T@> (5)@
+  @\fBsocket\fP(7)@S@S@> socket connection@
+5@\fBstartup\fP(7)@S@I@Boot@J
+  @\fBstarted\fP(7)@S@I@> job started@K
+  @\fBstarting\fP(7)@H@I@< job starts@K
+  @\fBstopped\fP(7)@S@I@> job stopped@K
+  @\fBstopping\fP(7)@H@I@< job stops@K
+  @T{
+unmounted\-\:remote\-\:filesystems
+T}@H@V@T{
+> last remote FS unmounted
+T}@L
+6@\fBvirtual\-\:filesystems\fP(7)@S@M@> last virtual FS (1)@M
 .TE
 .po \n[old_po]
 .in \n[old_in]
 .P
 Key:
-  \'FS\' is an abbreviation for filesystem.
-  \'DM\' is an abbreviation for Display Manager.
+  \(aqFS\(aq is an abbreviation for filesystem.
+  \(aqDM\(aq is an abbreviation for Display Manager.
 
 .\"
 .P
@@ -119,15 +126,16 @@
 Ref@Emitter@Notes
 =
 A@System Administrator (initiator)@Technically emitted by init(8).
-B@\fBdbus-daemon\fP(1)@Run with "\fI--activation=upstart"\fP
+B@\fBdbus\-daemon\fP(1)@Run with "\fI\-\-activation=upstart"\fP
 D@Display Manager@e.g. gdm/kdm/xdm.
 F@\fBifup\fP(8) or \fBifdown\fP(8)@See \fI/etc/network/\fP.
 I@\fBinit\fP(8)@
 M@\fBmountall\fP(8)@
-N@network-interface job@
-S@\fBupstart-socket-bridge\fP(8)@
+N@network\-interface job@
+S@\fBupstart\-socket\-bridge\fP(8)@
 T@\fBtelinit\fP(8), \fBshutdown\fP(8)@
-U@\fBupstart-udev-bridge\fP(8)@
+U@\fBupstart\-udev\-bridge\fP(8)@
+V@System V init system@
 .TE
 .po \n[old_po]
 .in \n[old_in]
@@ -145,42 +153,41 @@
 c | l.
 Note@Detail
 =
-A@Initial event.
-B@T{
-Emitted when mount attempt for single entry from \fBfstab\fP(5)
-for any filesystem type is about to begin.
-T}
-C@Generated for each mount that completes successfully.
-D@Emitted when all virtual filesystems (such as \fI/proc\fR) mounted.
-E@Note this is in the singular - there is no \'filesystems\' event.
-F@T{
+A@T{
 Requires administrator to press Control-Alt-Delete key
 combination on the console.
 T}
-G@T{
+B@Event generated when user performs graphical login.
+C@T{
+These are specific examples. \fBupstart\-udev\-bridge\fP(8) will emit
+events which match the pattern, "\fIS\fP\-device\-\fIA\fP" where
+\(aqS\(aq is the udev \fIsubsystem\fP and \(aqA\(aq is the udev \fIaction\fP. See
+\fBudev\fP(7) and for further details. If you have sysfs
+mounted, you can look in \fI/sys/class/\fP for possible values for subsystem.
+T}
+D@Note this is in the singular - there is no \(aqfilesystems\(aq event.
+E@T{
 Emitted when administrator presses Alt-UpArrow key combination on
 the console.
 T}
-H@Emitted when Upstart receives the SIGPWR signal.
-I@T{
+F@T{
 Denotes Display Manager running (about to be displayed), but no users
 logged in yet.
 T}
-
-J@Event generated when user performs graphical login.
+G@Generated for each mount that completes successfully.
+H@T{
+Emitted when mount attempt for single entry from \fBfstab\fP(5)
+for any filesystem type is about to begin.
+T}
+I@Emitted when Upstart receives the SIGPWR signal.
+J@Initial event.
 K@T{
-These are specific examples. \fBupstart-udev-bridge\fP(8) will emit
-events which match the pattern, "\fIS\fP-device-\fIA\fP" where \'S\' is
-the udev \fIsubsystem\fP and \'A\' is the udev \fIaction\fP. See
-\fBudev\fP(7) and for further details. If you have
-.BR sysfs (2)
-mounted, you can look in \fI/sys/class/\fP for possible values for subsystem.
-T}
-L@T{
 Although the events are emmitted by \fBinit\fP(8), the instigator may be
 \fBinitctl\fP(8) if a System Administrator has manually started or
 stopped a job.
 T}
+L@\fI/etc/init/umountnfs.sh\fP.
+M@Emitted when all virtual filesystems (such as \fI/proc\fR) mounted.
 .TE
 .po \n[old_po]
 .in \n[old_in]
@@ -193,7 +200,7 @@
 Upstart emits the \fBstarting\fP(7) event denoting the job is
 "about to start". The \fBstarting\fP(7) event completes.
 .IP \n+[step] 3
-If the \fBpre-start\fP stanza exists, the pre-start process is
+If the \fBpre\-start\fP stanza exists, the pre\-start process is
 spawned.
 .IP \n+[step] 3
 Upstart spawns the main process.
@@ -202,7 +209,7 @@
 descendent of the immediate child process if \fBexpect fork\fP or
 \fBexpect daemon\fP has been specified.
 .IP \n+[step] 3
-If the \fBpost-start\fP stanza exists, the post-start process is
+If the \fBpost\-start\fP stanza exists, the post\-start process is
 spawned.
 .IP \n+[step] 3
 Upstart emits the \fBstarted\fP(7) event.
@@ -214,7 +221,7 @@
 
 .nr step 1 1
 .IP \n[step] 3
-If the \fBpre-stop\fP stanza exists, the pre-stop process is
+If the \fBpre\-stop\fP stanza exists, the pre\-stop process is
 spawned.
 .IP \n+[step] 3
 The main process is stopped:
@@ -234,7 +241,7 @@
 .IP \n+[step] 3
 Upstart emits the \fBstopping\fP(7) event.
 .IP \n+[step] 3
-If the \fBpost-stop\fP stanza exists, the post-stop process is
+If the \fBpost\-stop\fP stanza exists, the post\-stop process is
 spawned.
 .IP \n+[step] 3
 Upstart emits the \fBstopped\fP(7) event.
 
=== modified file 'init/tests/test_control.c'
--- init/tests/test_control.c	2011-02-23 09:35:03 +0000
+++ init/tests/test_control.c	2011-03-24 16:01:02 +0000
@@ -933,9 +933,12 @@
 
 	strcpy (filename, dirname);
 	strcat (filename, "/baz");
+
+	/* XXX: note that this will generate an error message when this
+	 * test runs sine "/baz" does not exist as a directory.
+	 */
 	source3 = conf_source_new (NULL, filename, CONF_DIR);
 
-
 	message = nih_new (NULL, NihDBusMessage);
 	message->connection = NULL;
 	message->message = NULL;
 
=== modified file 'po/upstart.pot'
--- po/upstart.pot	2011-03-15 16:22:27 +0000
+++ po/upstart.pot	2011-03-24 16:01:02 +0000
@@ -6,9 +6,9 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: upstart 0.9.3\n"
+"Project-Id-Version: upstart 0.9.4\n"
 "Report-Msgid-Bugs-To: [e-mail]\n"
-"POT-Creation-Date: 2011-03-15 14:08+0000\n"
+"POT-Creation-Date: 2011-03-24 11:26+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
 
=== modified file 'scripts/initctl2dot.py'
--- scripts/initctl2dot.py	2011-03-10 14:06:37 +0000
+++ scripts/initctl2dot.py	2011-03-24 16:01:02 +0000
@@ -32,12 +32,12 @@
 # Usage:
 #
 #   initctl show-config -e > initctl.out
-#   initctl2dot.py -f initctl.out -o upstart.dot
+#   initctl2dot -f initctl.out -o upstart.dot
 #   dot -Tpng -o upstart.png upstart.dot
 #
 # Or more simply:
 #
-#  initctl2dot.py -o - | dot -Tpng -o upstart.png
+#  initctl2dot -o - | dot -Tpng -o upstart.png
 #
 # See also:
 #
@@ -48,6 +48,7 @@
 
 import sys
 import re
+import fnmatch
 import os
 from string import split
 import datetime
@@ -78,12 +79,15 @@
 def header(ofh):
   global options
 
-  str  = "digraph upstart {"
-  str += "  node [shape=record];"
-  str += "  rankdir=LR;"
-  str += "  overlap=false;"
-  str += "  bgcolor=\"%s\";" % options.color_bg
-  str += "  fontcolor=\"%s\";" % options.color_text
+  str  = "digraph upstart {\n"
+
+  # make the default node an event to simplify glob code
+  str += "  node [shape=\"diamond\", fontcolor=\"%s\", fillcolor=\"%s\", style=\"filled\"];\n" \
+    % (options.color_event_text, options.color_event)
+  str += "  rankdir=LR;\n"
+  str += "  overlap=false;\n"
+  str += "  bgcolor=\"%s\";\n" % options.color_bg
+  str += "  fontcolor=\"%s\";\n" % options.color_text
 
   ofh.write(str)
 
@@ -107,11 +111,12 @@
       (cmd, os.uname()[1])
 
   epilog += "Boxes of color %s denote jobs.\\n" % options.color_job
-  epilog += "Diamonds of color %s denote events.\\n" % options.color_event
+  epilog += "Solid diamonds of color %s denote events.\\n" % options.color_event
+  epilog += "Dotted diamonds denote 'glob' events.\\n"
   epilog += "Emits denoted by %s lines.\\n" % options.color_emits
   epilog += "Start on denoted by %s lines.\\n" % options.color_start_on
   epilog += "Stop on denoted by %s lines.\\n" % options.color_stop_on
-  epilog += "\";"
+  epilog += "\";\n"
   epilog += "}\n"
   ofh.write(epilog)
 
@@ -121,7 +126,7 @@
 def sanitise(s):
   return s.replace('-', '_').replace('$', 'dollar_').replace('[', \
   'lbracket').replace(']', 'rbracket').replace('!', \
-  'bang').replace(':', '_')
+  'bang').replace(':', '_').replace('*', 'star').replace('?', 'question')
 
 
 # Convert a dollar in @name to a unique-ish new name, based on @job and
@@ -148,10 +153,17 @@
 
 def show_event(ofh, name):
     global options
-    ofh.write("""
-    %s [label=\"%s\", shape=diamond, fontcolor=\"%s\", fillcolor=\"%s\", style=\"filled\"];
-    """ % (mk_event_node_name(name), name, options.color_event_text, options.color_event))
-
+    str = "%s [label=\"%s\", shape=diamond, fontcolor=\"%s\", fillcolor=\"%s\"," % \
+      (mk_event_node_name(name), name, options.color_event_text, options.color_event)
+
+    if '*' in name:
+      str += " style=\"dotted\""
+    else:
+      str += " style=\"filled\""
+
+    str += "];\n"
+
+    ofh.write(str)
 
 def show_events(ofh):
   global events
@@ -193,7 +205,7 @@
   global options
 
   ofh.write("""
-    %s [label=\"<job> %s | { <start> start on | <stop> stop on }\", fontcolor=\"%s\", style=\"filled\", fillcolor=\"%s\"];
+    %s [shape=\"record\", label=\"<job> %s | { <start> start on | <stop> stop on }\", fontcolor=\"%s\", style=\"filled\", fillcolor=\"%s\"];
     """ % (mk_job_node_name(name), name, options.color_job_text, options.color_job))
 
 
@@ -288,6 +300,8 @@
   global options
   global restrictions_list
 
+  glob_jobs = {}
+
   if restrictions_list:
     jobs_list = restrictions_list
   else:
@@ -308,6 +322,14 @@
       show_stop_on_event_edge(ofh, job, s)
 
     for e in jobs[job]['emits']:
+      if '*' in e:
+        # handle glob patterns in 'emits'
+        glob_events = []
+        for _e in events:
+          if e != _e and fnmatch.fnmatch(_e, e):
+            glob_events.append(_e)
+        glob_jobs[job] = glob_events
+
       show_job_emits_edge(ofh, job, e)
 
     if not restrictions_list:
@@ -325,6 +347,12 @@
       for e in jobs[j]['emits']:
         show_job_emits_edge(ofh, j, e)
 
+  # Create links from jobs (which advertise they emits a class of
+  # events, via the glob syntax) to all the events they create.
+  for g in glob_jobs:
+    for ge in glob_jobs[g]:
+      show_job_emits_edge(ofh, g, ge)
+
   if not restrictions_list:
     return