summaryrefslogtreecommitdiff
path: root/docs/reference/node-startup-controller
Commit message (Collapse)AuthorAgeFilesLines
* doc: move xml tag to top line of filePhong Tran2019-12-0312-12/+12
| | | | | | | | | | There are errors with multiple docbook xml file while make documentation. ../node-startup-controller-docs.xml:10: parser error : XML declaration allowed only at the start of the document Signed-off-by: Phong Tran <tranmanphong@gmail.com>
* Change docs license to CC-BY-SA 4.0 and update licensing to GENIVI standardJonathan Maw2015-04-3012-0/+108
| | | | | | | | | | | | | | | | The previous docs format, CC 1.0, is not recommended by GENIVI, and the preferred one is CC-BY-SA 4.0. Other license changes are: * Add Creative Commons copyright headers to documentation. * Add copyright headers to test code. * Add copyright headers to dbus XML that belongs to the NSC. * Update copyright headers to GENIVI's standard. Notable exceptions are: * dbus XML that is used to communicate with other services (e.g. common/nsm-consumer-dbus.xml) has not had copyright statements added, because the Node Startup Controller does not own that interface.
* Unify spelling of focussed.targetErik Botö2014-12-041-2/+2
| | | | | | | Make sure we use the same spelling of focussed in all places to avoid confusion. Signed-off-by: Erik Botö <erik.boto@pelagicore.com>
* Reword functional scope to be more accessibleJonathan Maw2013-02-181-15/+67
|
* Add autogen scriptJonathan Maw2012-11-061-1/+1
| | | | | | | | | | | This commit simplifies the build process by adding an autogen script to handle the creation of an m4 directory and execution of gtkdocize and autoreconf. Documentation on building has been updated accordingly. Signed-off-by: Jonathan Maw <jonathan.maw@codethink.co.uk> Signed-off-by: Jannis Pohlmann <jannis.pohlmann@codethink.co.uk>
* Fix minor inconsistencies in expected test output.Jonathan Maw2012-08-102-3/+3
| | | | | | | In test-legacy-app-handling.xml, the timeout was wrong. In test-target-startup-monitoring, the phrase "Applied the node state N" had been changed to "Node state N applied" in everywhere but one place.
* Rename all com.contiautomotive to org.geniviJonathan Maw2012-08-101-2/+2
|
* Update log messages in the TargetStartupMonitor test case docsFrancisco Redondo Marchena2012-08-081-5/+5
| | | | | Replace the old DLT messages in the TargetStartupMonitor test case documetnation with the ones we currently use.
* License the reference manual under Creative Commons CC0 1.0 UniversalJannis Pohlmann2012-08-071-0/+8
| | | | | Add a dedicated COPYING.docs file for this. The license is also mentioned again in the reference manual itself.
* Rewrite documentation for legacy app handler testJonathan Maw2012-08-061-106/+102
| | | | | | | | | | | | | | | | | Removed the requirement to restart the system for each test, instead just restart the node startup controller for each test. The downside of this is that the dlt.log file is not reset so may become very large. Reduced the number of DLT log messages to compare against the output. Instead, only the most relevant lines are included for each test. Added separate test that the Node Startup Controller registers itself. Rewrote the descriptions for each test case to be more readable. Numbered each test case. Spelling and grammar fixes.
* Apply minor fixes for building the reference manualJannis Pohlmann2012-08-062-3/+5
|
* Make sure to set GTKDOC_CFLAGS/GTKDOC_LIBS properlyJannis Pohlmann2012-08-061-2/+18
|
* Fix Test legacy app handling purpose, error in logs and commandsFrancisco Redondo Marchena2012-08-032-17/+17
| | | | | | Fix in Test legacy app handling documentation the purpose, some error logs and some commands. Fix duplicate will in about.xml
* Fix a markup error in building.xmlJannis Pohlmann2012-08-031-0/+1
|
* Document the --enable-gtk-doc configure option in the manualJannis Pohlmann2012-08-031-0/+8
|
* Use passive language in test-test-environment-setup.xmlJonathan Maw2012-08-031-6/+6
| | | | | | Changes the single instance of "we" in this file. Minor grammatical fixes.
* Grammatical fix to test-nsm-dummy.xmlJonathan Maw2012-08-031-12/+12
| | | | | | It now uses passive language throughout. Other minor grammatical fixes
* Make the description of the NSM dummy more clear to unfamiliar readersJannis Pohlmann2012-08-031-2/+9
|
* Fix the link to test-luc-finish-onlyFrancisco Redondo Marchena2012-08-031-1/+1
|
* Finish documentation of build commandsJannis Pohlmann2012-08-031-2/+88
|
* Fix conflicting part/refentry IDs to make the building page show upJannis Pohlmann2012-08-031-1/+1
|
* Add required command line utilities to build dependency docsJannis Pohlmann2012-08-031-0/+12
|
* Add library dependencies for building to the docsJannis Pohlmann2012-08-031-0/+25
|
* Fix the title of the Test legacy application handler.Francisco Redondo Marchena2012-08-031-3/+3
| | | | | Replace the previous title by "Tests for legazy application handling". Fix some paragraphs.
* Better test case titles and always set the node state in TSM testsJonathan Maw2012-08-032-51/+61
| | | | | | | | | | | | | Test titles are made more descriptive by including the name of the node state which is being set. A link is included to the enum which defines the NSMNodeState. Tests are changed to always set the node state. This is done by starting the unit twice in most cases. In addition, the less-important lines in the DLT log output are no longer specified. Capitalization in titles has been cleaned up somewhat.
* Add the documentation for legacy app handling testsFrancisco Redondo Marchena2012-08-031-0/+270
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add the documentation for legacy app handling tests. The following tests are provided: 1. Register a normal and a fast shutdown consumer. - Check that node-startup-controller.service registers itself as a shutdown consumer. - Check that the registration for the shutdown consumer are ok. - Check that in the process of shutting down the fast consumers shutting down first and the normal consumers second. - Check that the shutdown consumers are unregister as a shutdown consumers when they have been shutting down. - Check that node-startup-controller.service unregisters itself as a shutdown consumer when it has been shutting down. 2. Register two normal shutdown consumers - Check that in the process of shutting down the consumers are shutting down in reverse order of registration. 3. Register a shutdown consumer twice within different modes and timeouts - Check that the re-registration modify the final mode to a combination of both modes (normal and fast) and the timeout has been set to the last registration value of timeout. - Check that in the process of shutting down the consumer is shutting down for the both modes. 4. Register a shutdown consumer with invalid arguments - Check that register a consumer without unit name fails. - Check that register a consumer within mode 0 fails - Check that register a consumer with a negative timeout fails.
* Document that timeout is non-mandatory parameter and its default valueFrancisco Redondo Marchena2012-08-031-2/+2
| | | | | | Modify in the documentation for legacy app handler that timeout is a non-mandatory legacy app handler argument and its default value is 1000 milliseconds.
* Add NSM dummy documentation pageJannis Pohlmann2012-08-031-0/+56
|
* Restructure and number the Target Startup Monitoring testsJonathan Maw2012-08-031-121/+171
| | | | Tests are restructured in the same way as the previous commit
* Number and restructure luc management test casesJonathan Maw2012-08-031-135/+199
| | | | | | | Test cases are restructured into: * Description * Test Commands * Desired behaviour and Output
* Add missing XML files to the reference manual Makefile.amJannis Pohlmann2012-08-033-0/+21
|
* Work on documentation of functional scope and interfacesJannis Pohlmann2012-08-033-6/+127
| | | | Also fix a mistyped systemd command.
* Rework reference manual a bit, start reworking test case layoutJannis Pohlmann2012-08-0211-408/+509
|
* Split test scenarios into separate pages, add legacy app skeletonJonathan Maw2012-08-025-299/+286
| | | | | | | | | | | | | | Each test scenario (i.e. luc, legacy app, tsm) has been split into a separate file. Setup steps which have to be performed for every scenario are moved into test-general-setup.xml Cross-references are used so that the test overview links to each test case, and the "Testing" page links to the general setup and also each test. test-example has been removed because it is no longer necessary.
* Add test scenarios for the Last User Context handlingJonathan Maw2012-08-022-0/+278
| | | | | | | | | | The following test scenarios are added to the documentation: * Registration of a simple dictionary * Registration does not happen on an isolated RegisterWithLUC() call * An isolated FinishLUCRegistration() call will not change the LUC * Registration of a complex dictionary * Registration can happen with a series of RegisterWithLUC() calls * Repeated registration of an app changes the order in the LUC
* Specify difference between NSM and NSM dummy in docmentationJonathan Maw2012-08-022-6/+15
| | | | | | | | | | | Explicitly states the difference between the Node State Manager Dummy and the real Node State Manager, i.e. * The NSM dummy toggles between successfully setting the node state and failing to set the node state. * The NSM dummy toggles between the LUC being required, and the LUC not being required. * The NSM dummy will shut down its fast shutdown clients, then its normal shutdown clients, on receiving the SIGHUP signal
* Add TSM test and improve layout of test documentJonathan Maw2012-08-023-31/+202
| | | | | | | | | | | | | | | The improvements to the layout of the test document are that the individual tests will now show up on the table of contents. The Target Startup Monitor (TSM) tests check that the following cases attempt to change the node state: * The Node Startup Controller starting * focussed.target starting * unfocussed.target starting * lazy.target starting The following case should not attempt to change the node state: * focussed.target stopping
* Add testing skeletonJonathan Maw2012-08-022-3/+74
| | | | Lays out the structure of the test document XML
* Rename all remaining bits and piecesJannis Pohlmann2012-07-312-5/+4
|
* Rename service files and boot-manager binaryJannis Pohlmann2012-07-311-1/+1
|
* Rename BootManagerApplication to NodeStartupControllerApplicationJannis Pohlmann2012-07-311-1/+1
|
* Rename boot manager D-Bus interface and BootManagerService classJannis Pohlmann2012-07-311-2/+2
|
* First step of renaming the Boot Manager to Node Startup ControllerJannis Pohlmann2012-07-312-4/+4
| | | | | This includes mostly files, directories and the package/tarball name. The classes and D-Bus interfaces will be renamed in the next step.
* Retrieve invalidated properties before emitting "g-properties-changed"Francisco Redondo Marchena2012-07-311-0/+1
| | | | | | | | | | It seems like the "active-state" property might be part of the invalidated properties, not the changed ones. By passing G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES to the proxy constructor we force GDBusProxy to retrieve the new "active-state" value before calling "g-properties-changed". Hopefully this will fix TargetStartupMonitor for real.
* Rework small bits of the legacy-app-handler documentationJannis Pohlmann2012-07-311-9/+9
|
* Document the legacy app handler APIJonathan Maw2012-07-311-2/+52
|
* Apply a few changes to fix make distcheck and regular buildsJannis Pohlmann2012-07-302-2/+3
|
* Add initial version of the reference manual templatesJannis Pohlmann2012-07-304-9/+174
| | | | | Most of the chapters in this manual still need to be written but this is a start.
* Add rudimentary gtk-doc support to the projectJannis Pohlmann2012-07-301-0/+99
This includes adjusting the configure script to check for gtk-doc as well as creating the necessary directories and Makefile.am files. At the moment, no documentation is generated. We'll have to add initial templates that include the docbook XML generated for the D-Bus API.