Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
6
66
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Eric Vidal
66
Commits
8ec63d42
Commit
8ec63d42
authored
5 years ago
by
Eric Vidal
Browse files
Options
Downloads
Patches
Plain Diff
update doc
parent
aaa822ef
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/html/frontend.html
+14
-30
14 additions, 30 deletions
doc/html/frontend.html
doc/man/66-frontend.5.scd
+14
-5
14 additions, 5 deletions
doc/man/66-frontend.5.scd
with
28 additions
and
35 deletions
doc/html/frontend.html
+
14
−
30
View file @
8ec63d42
...
...
@@ -237,12 +237,21 @@ MYVALUE</pre>
<li><h4>
@name
</h4></li>
<h5>
Corresponds to the
<em>
name of the service directory
</em>
of s6 and s6-rc programs.
</h5>
<p>
Name of the service.
</p>
<p><tt>
mandatory
</tt>
:
yes (!)
</p>
<p><tt>
mandatory
</tt>
:
no
</p>
<p><tt>
syntax
</tt>
: inline
</p>
<p><tt>
valid values
</tt>
:
</p>
<ul>
<li>
Any name can be set as a
<em>
value
</em>
. A good pratice is to use the
same name of the frontend service file.
</li>
<li>
This field has
<strong>
no effect
</strong>
except for
<tt><a
href=
"#instance"
>
instantiated
</a></tt>
services. In such case
the name
<strong>
must
</strong>
contain the complete name of the
frontend service file.
</p>
<p>
For example, the following is valid:
</p>
<pre>
@name = tty@mine-@I
</pre>
<p>
where:
</p>
<pre>
@name = mine-@I
</pre>
<p>
is not for a frontend service file named tty@.
</p>
</li>
</ul>
<br><hr
style=
"border: 1px dashed #000000"
>
...
...
@@ -304,29 +313,7 @@ MYVALUE</pre>
to the dependencies of fooA.
</li>
<!-- Taking an another example :
FooA depens of FooB which depends of FooC, your service file can just declare FooB and
the parser will automatically add FooB because in your service file of FooB you declare
FooC as dependencies, so
FooA service file is : @depends=( FooB )
FooB service file is : @depends=( FooC )
Now we have FooA service BooA service and CooA service, FooA depends on BooA which
depends of CooA.
FooA service : @depends = ( BooA ) ;
BooA service : @depends = ( BooB BooC BooD CooA ) ;
CooA service : @depends = ( CooB CooC) ;
the complete chained dependency should be :
FooA service : @depends = ( BooA BooB BooC BooD CooA CooB CooC ) ;
BooA service : @depends = ( BooB BooC BooD CooA CooB CooC )
CooA service : @depends = ( CooB CooC) ;
So you're right, the sentence is not clear.
-->
</ul>
</ul>
<br><hr
style=
"border: 1px dashed #000000"
>
...
...
@@ -837,15 +824,13 @@ for it in your <tt>@execute</tt> field.</p>
<li>
the name of the file needs to be appended with an '@' (commercial at) character.
</li>
<li>
every value replaced in an instance file needs to be written with '@I'.
</li>
</ul>
<!-- Apart from the example I think a short explanation of instances would be very helpful. Could be a use case, or just a general situation. -->
<p>
Example :
</p>
<p>
Example :
</p>
<pre>
File name : tty@
Contents :
[main]
@type = classic
@name = @I
@description = "Launch @I"
@user = ( root )
...
...
@@ -856,7 +841,6 @@ for it in your <tt>@execute</tt> field.</p>
<p>
By using
<tt><a
href=
"66-enable.html"
>
66-enable tty@tty1
</a></tt>
, the resulting file will then be:
</p>
<pre>
[main]
@type = classic
@name = tty1
@description = "Launch tty1"
@user = ( root )
...
...
This diff is collapsed.
Click to expand it.
doc/man/66-frontend.5.scd
+
14
−
5
View file @
8ec63d42
...
...
@@ -145,11 +145,22 @@ Valid _key_ names:
*
@
name
*++
Name
of
the
service
.
++
_mandatory_:
*
yes
*++
_mandatory_:
*
no
*++
_syntax_:
*
inline
*++
_valid
values_:
++
Any
name
can
be
set
as
a
_value_
.
A
good
pratice
is
to
use
the
same
++
name
of
the
frontend
service
file
.
This
field
has
*
no
effect
*
except
for
instantiated
services
.
In
such
case
the
name
*
must
*
contain
the
complete
name
of
the
frontend
service
file
.
For
example
,
the
following
is
valid:
@
name
=
tty
@
mine
-
@
I
where:
@
name
=
mine
-
@
I
is
not
for
a
frontend
service
file
named
tty
@
.
Corresponds
to
the
_name_
of
the
service
directory
of
s6
and
s6
-
rc
programs
.
...
...
@@ -666,7 +677,6 @@ Contents:
```
[
main
]
@
type
=
classic
@
name
=
@
I
@
description
=
"Launch @I"
@
user
=
(
root
)
...
...
@@ -679,7 +689,6 @@ Contents:
```
[
main
]
@
type
=
classic
@
name
=
tty1
@
description
=
"Launch tty1"
@
user
=
(
root
)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment