Skip to content

Commit 17cf6b0

Browse files
committed
Minor documentation improvements
Change some instances of '=' in example settings to ':', and mention "triggered" services when discussing service types.
1 parent b6abd06 commit 17cf6b0

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,10 @@ a feel for what using Dinit is like. For a complete reference, see the _man_ pag
124124
A "service" is nominally a persistent process or system state. The two main
125125
types of service are a _process_ service (represented by a an actual process)
126126
and a _scripted_ service (which is started and stopped by running a process -
127-
often a shell script - to completion). There are also _bgprocess_ services
128-
and _internal_ services. See the [dinit-service(5)](https://davmac.org/projects/dinit/man-pages-html/dinit-service.5.html)
127+
often a shell script - to completion). There are also _bgprocess_ services (for processes which
128+
put themselves "in the background" by forking), _internal_ services (useful for grouping other
129+
processes or acting as checkpoints), and _triggered_ services (which require an external event
130+
or trigger to start). See the [dinit-service(5)](https://davmac.org/projects/dinit/man-pages-html/dinit-service.5.html)
129131
manual page for details.
130132

131133
Many programs that you might want to run under Dinit's supervision can run
@@ -155,7 +157,7 @@ the [doc/linux/services](doc/linux/services) directory).
155157
A service description file has a textual format and consists of a number of
156158
parameter settings. Some examples of the available parameters are:
157159

158-
type = process | bgprocess | scripted | internal
160+
type = process | bgprocess | scripted | internal | triggered
159161
command = ...
160162
stop-command = ...
161163
run-as = (user-id)
@@ -173,8 +175,8 @@ for general operation). For example, a service description for `sshd` might look
173175

174176
type = process
175177
command = /usr/sbin/sshd -D
176-
waits-for = syslogd
177-
depends-on = loginready
178+
waits-for: syslogd
179+
depends-on: loginready
178180

179181
In this example, `syslogd` and `loginready` are also services (which must have their own service
180182
descriptions).

doc/getting_started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ Create (using your preferred text editor) a file called `boot` (under the
3232
directory we just made) and put as its contents:
3333
```
3434
type = internal
35-
waits-for.d = boot.d
35+
waits-for.d: boot.d
3636
```
3737

3838
The first line (`type = internal`) tells dinit that this is not a service which
3939
will run any external process directly.
4040

41-
The second line (`waits-for.d = boot.d`) specifies a directory which will be
41+
The second line (`waits-for.d: boot.d`) specifies a directory which will be
4242
used to keep track of which services should be started when dinit starts (or
4343
more specifically, which services should be started before the `boot` service).
4444
Here we've made it a `boot.d` sub-directory under our main `dinit.d` directory,

0 commit comments

Comments
 (0)