Skip to content

Commit

Permalink
Doc: add note on resolution of relative paths in service descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
davmac314 committed Dec 14, 2024
1 parent d333d41 commit 39c3047
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
7 changes: 5 additions & 2 deletions doc/manpages/README
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,17 @@ Inline formatting ("escapes"):
\fR - set regular (i.e. unset bold & italic)


Special characters:
Special characters (see groff_char(7)):
'\ ' - (backslash followed by space) - non-breaking space
\& - zero-width space
\- - literal hyphen (also suppresses line breaking through dash)
\(em - em-dash (GNU groff accepts "\[em]" as well but it may not be portable)
\(en - en-dash
\(bu - bullet point

` and ' (backtick / apostrophe) - use for opening/closing single quotes


Line commands ("requests"):

.\" - begins a comment line (may be used for spacing in source document without the effect that having a
Expand Down Expand Up @@ -60,7 +63,7 @@ This should be followed by a NAME section:

Gotchas:

* Sentences should always end at the end of a line (this affects spacing in output).
* Sentences should always end (with a period) at the end of a line (this affects spacing in output).
* hyphens which are actually part of a word (part of a setting name for example) should be
preceded by a backslash ("\-") which will prevent the literal from being split over multiple lines.
* Blank lines should be avoided. Use .LP/.HP/.TP/.IP for example to start a paragraph. Use .IP for
Expand Down
8 changes: 8 additions & 0 deletions doc/manpages/dinit-service.5.m4
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,14 @@ Setting a property generally overrides any previous setting (from prior lines).
However some properties are set additively; these include dependency relationships and \fBoptions\fR
properties.
.LP
Some properties that specify file paths are currently resolved (if the specified path is relative)
starting from the directory containing the top-level service description file, whereas others are
resolved from the directory containing the service description fragment in which the setting value
is defined (a "fragment" may be the service description file itself, or it may be a file included
via \fB@include\fR or similar; see \fBMETA-COMMANDS\fR). In particular, the `\-\-\-.d' settings
(such as \fBwaits-for.d\fR) are resolved from the containing fragment. For all other settings, it
is recommended to provide absolute paths to be robust against future changes in Dinit.
.LP
The following properties can be specified:
.TP
\fBtype\fR = {process | bgprocess | scripted | internal | triggered}
Expand Down

0 comments on commit 39c3047

Please sign in to comment.