Commit cbfdcd92 authored by Eric Vidal's avatar Eric Vidal 💬

Merge branch 'mobinmob/66-doc-fixes-proposal' into dev

parents a8be14e9 8d30e5cb
......@@ -17,16 +17,16 @@
<h1>66-update</h1>
<p>
66-update is a program that is normally used very rarely: when the
66 package is upgraded or downgraded, some services are currently managed,
different tree as declared and the inner format has changed. This program transitions
a complete tree and a live directory using a database with the old 66 format (the one being replaced)
so that it uses a database with the new 66 format and rebuild the tree.
<p>
66-update is a program that should be used rarely. At upgrade/downgrade time, the inner file format
used to retrieve informations of tree,service database currently in use, can differ between two versions.
In this case, service databases and trees need to be rebuild to match the new format.The 66-update program makes
a complete transition of trees and the live directory using a old 66 format (the one being replaced) with the new
66 format.
</p>
<p>
The point is to ensure a smooth transition between different versions of 66 without needing a reboot.
The goal is to ensure a smooth transition between different versions of 66 without needing a reboot.
</p>
<h2>Interface</h2>
......@@ -67,9 +67,9 @@
<ul>
<li>
It determines if the tree is already initialized. In such case, it
make a copy of the current database on a temporary directory and
switch the database to it.
It determines if the tree is already initialized. if it is, it
+ makes a copy of the current database on a temporary directory and
+ switches the database to it.
</li>
<li>
It saves the current state of the tree (current,enabled,...).
......@@ -79,7 +79,7 @@
</li>
<li>
It creates the tree with <tt><a href="66-tree.html">66-tree -n(cEa)</a></tt> command,
options depending of the saved state.
options depending on the saved state.
</li>
<li>
It enables the service(s) previously declared on the <em>tree</em>.
......@@ -89,14 +89,14 @@
</li>
</ul>
<p>
At the end of the process, the tree and the live state has not changed. Services already is use
At the end of the process, the tree and the live state has not changed. Services already in use
are not stopped or restarted during the transition process and match exactly the same state
before and after the process.
</p>
<p>
It try to be safe as possible and exit 111 is a problem occurs. In any case
It tries to be safe as possible and exits 111 if a problem occurs. In any case
on upgrade/downgrade time, 66 tools will not work properly if the transition
is not made smoothly even by the sysadmin itself. So, We prefer to cratch instead of
is not made smoothly even by the sysadmin itself. So, We prefer to crash instead of
leaving an inconsistent state and let the sysadmin correct the things.
</p>
</body>
......
......@@ -328,28 +328,28 @@ MYVALUE</pre>
A service declared as optional dependencies is not mandatory.
The parser will look at all trees if the corresponding service is
already enabled:
<ul>
<li>If It the case, it warn the user and do nothing.</li>
<li>If not, it tries to find the corresponding frontend file.
<ul>
<li>If the frontend service file is found, it enable it.</li>
<li>If it not found it, it warn the user and do nothing</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>The <em>order is of importance</em> (!). The first service found
<ul>
+ <li>If enabled, it will warn the user and do nothing.</li>
+ <li>If not, it will try to find the corresponding frontend file.
+ <ul>
+ <li>If the frontend service file is found, it will enable it.</li>
+ <li>If it is not found, it will warn the user and do nothing.</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+</ul>
<p>The <em>order is important</em> (!). The first service found
will be used and the parse process of the field will be stopped.
So, you can considere @optsdepends field as:
"enable one on this service or none".
</p>
<p>
We talk about enable process here. The start process will not take care
about optional dependencies. If fooA on treeA have an optional dependency fooB which is
declared on treeB, it's the responsability of the sysadmin to start first
treeB then treeA. <tt><a href="66-intree.html">66-intree</a></tt> give you
the order of the start with the field <tt>Start after</tt>.
@optsdepends only affects the enable process. The start process will not consider
+ optional dependencies. If fooA on treeA has an optional dependency fooB which is
+ declared on treeB, it's the responsibility of the sysadmin to start first
+ treeB then treeA. <tt><a href="66-intree.html">66-intree</a></tt> can give you
+ the start order with the field <tt>Start after</tt>.
</p>
<li><h4>@extdepends</h4></li>
......@@ -363,32 +363,32 @@ MYVALUE</pre>
<li>The <em>name</em> of any valid service with type
<tt>bundle</tt>, <tt>longrun</tt> or <tt>oneshot</tt>. Services of type <tt>classic</tt>
are not allowed.
A service declared as external dependencies is mandatory.
The parser will look at all trees if the corresponding service is
+ A service declared as an external dependencies is mandatory.
+ The parser will search through all trees whether the corresponding service is
already enabled:
<ul>
<li>If It the case, it warn the user and do nothing.</li>
<li>If not, it tries to find the corresponding frontend file.
<ul>
<li>If the frontend service file is found, it enable it.</li>
<li>If it not found it, the process is stopped and
<a href="66-enable.html">66-enable</a> exit 111.</li>
</ul>
</li>
</ul>
<ul>
+ <li>If enabled, it will warn the user and do nothing.</li>
+ <li>If not, it will try to find the corresponding frontend file.
+ <ul>
+ <li>If the frontend service file is found, it will enable it.</li>
+ <li>If not, the process is stopped and
+ <a href="66-enable.html">66-enable</a> exits 111.</li>
+ </ul>
+ </li>
+ </ul>
<br>
This process is made for all services declared in the field.
</li>
</ul>
<br>
<p>So, you can considere @extdepends field as:
"enable the service if it not already declared on a tree".
<p>So, you can consider @extdepends field as:
+ "enable the service if it is not already declared on a tree".
</p>
<p>We talk about enable process here. The start process will not take care
about external dependencies. If fooA on treeA have an external dependency fooB which is
declared on treeB, it's the responsability of the sysadmin to start first
treeB then treeA. <tt><a href="66-intree.html">66-intree</a></tt> give you
the order of the start with the field <tt>Start after</tt>.</p>
<p>@extdepends only affects the enable process. The start process will not consider
+ external dependencies. If fooA on treeA has an external dependency fooB which is
+ declared on treeB, it's the responsibility of the sysadmin to start first
+ treeB then treeA. <tt><a href="66-intree.html">66-intree</a></tt> will give you
+ the start order with the field <tt>Start after</tt>.</p>
<br><hr style="border: 1px dashed #000000">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment