docs/reference/node-startup-controller/node-startup-controller-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3                       "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
   4 [
   5   <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
   6 ]>
   7
   8 <book id="index" lang="en">
   9   <bookinfo>
  10     <title>GENIVI Node Startup Controller Reference Manual</title>
  11     <releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo>
  12     <copyright>
  13       <year>2012</year>
  14       <holder>GENIVI</holder>
  15     </copyright>
  16     <authorgroup>
  17       <author>
  18         <firstname>Ben</firstname>
  19         <surname>Brewer</surname>
  20         <affiliation>
  21           <address><email>ben.brewer@codethink.co.uk</email></address>
  22         </affiliation>
  23       </author>
  24       <author>
  25         <firstname>Francisco Redondo</firstname>
  26         <surname>Marchena</surname>
  27         <affiliation>
  28           <address><email>francisco.marchena@codethink.co.uk</email></address>
  29         </affiliation>
  30       </author>
  31       <author>
  32         <firstname>Jannis</firstname>
  33         <surname>Pohlmann</surname>
  34         <affiliation>
  35           <address><email>jannis.pohlmann@codethink.co.uk</email></address>
  36         </affiliation>
  37       </author>
  38       <author>
  39         <firstname>Jonathan</firstname>
  40         <surname>Maw</surname>
  41         <affiliation>
  42           <address><email>jonathan.maw@codethink.co.uk</email></address>
  43         </affiliation>
  44       </author>
  45     </authorgroup>
  46   </bookinfo>
  47
  48   <chapter>
  49     <title>Node Startup Controller Overview</title>
  50     <sect1>
  51       <title>Purpose of the Reference Manual</title>
  52       <para>
  53         The purpose of this reference manual is to provide documentation about the public
  54         API of the Node Startup Controller as well as to give an overview of the classes
  55         used in the implementation internally.
  56       </para>
  57       <para>
  58         The intended readers of the reference manual are developers of GENIVI components
  59         that interact with the Node Startup Controller and people who want to contribute
  60         to the Node Startup Controller development. Reading this reference manual will
  61         will help them to understand how the Node Startup Controller can be used and how
  62         it is organised internally.
  63       </para>
  64     </sect1>
  65     <sect1>
  66       <title>Functional Overview</title>
  67     </sect1>
  68     <sect1>
  69       <title>Public API Overview</title>
  70     </sect1>
  71     <sect1>
  72       <title>Software Architecture</title>
  73     </sect1>
  74   </chapter>
  75
  76   <chapter>
  77     <title>Building, Installing and Testing the Node Startup Controller</title>
  78     <sect1>
  79       <title>Building</title>
  80     </sect1>
  81     <sect1>
  82       <title>Installing</title>
  83     </sect1>
  84     <sect1>
  85       <title>Testing</title>
  86     </sect1>
  87   </chapter>
  88
  89   <chapter>
  90     <title>Public API</title>
  91     <xi:include href="../../../boot-manager/boot-manager-dbus-doc-org.genivi.BootManager1.BootManager.xml"/>
  92     <xi:include href="legacy-app-handler.xml"/>
  93   </chapter>
  94
  95   <chapter id="node-startup-controller-classes">
  96     <title>Main Classes of the Node Startup Controller</title>
  97     <xi:include href="xml/boot-manager-application.xml"/>
  98     <xi:include href="xml/boot-manager-service.xml"/>
  99     <xi:include href="xml/job-manager.xml"/>
 100     <xi:include href="xml/la-handler-service.xml"/>
 101     <xi:include href="xml/luc-starter.xml"/>
 102     <xi:include href="xml/target-startup-monitor.xml"/>
 103   </chapter>
 104
 105   <chapter id="common">
 106     <title>Generated D-Bus Classes</title>
 107     <xi:include href="xml/boot-manager-dbus.xml"/>
 108     <xi:include href="xml/la-handler-dbus.xml"/>
 109     <xi:include href="xml/nsm-consumer-dbus.xml"/>
 110     <xi:include href="xml/nsm-lifecycle-control-dbus.xml"/>
 111     <xi:include href="xml/shutdown-consumer-dbus.xml"/>
 112     <xi:include href="xml/systemd-manager-dbus.xml"/>
 113   </chapter>
 114
 115   <chapter id="utilities">
 116     <title>Utilities</title>
 117     <xi:include href="xml/shutdown-client.xml"/>
 118     <xi:include href="xml/watchdog-client.xml"/>
 119     <xi:include href="xml/glib-extensions.xml"/>
 120     <xi:include href="xml/nsm-enum-types.xml"/>
 121   </chapter>
 122
 123   <index id="api-index-full">
 124     <title>API Index</title>
 125     <xi:include href="xml/api-index-full.xml">
 126       <xi:fallback />
 127     </xi:include>
 128   </index>
 129
 130   <xi:include href="xml/annotation-glossary.xml">
 131     <xi:fallback />
 132   </xi:include>
 133 </book>