The user should be informed that a state in a file will overrule a state
in an directory for gitfs_remotes because the remotes are merged
together to one structure.
An extra example should illustrate that it.
`documentation_options.js` from the default theme sets the option
`URL_ROOT` to:
```
document.getElementById("documentation_options").getAttribute('data-url_root')
```
This requires that the script element for `documentation_options.js`
includes the tag `id="documentation_options"` and sets the
`data-url_root` tag. Otherwise evaluating `URL_ROOT` will fail and
building the documentation during the Debian package build will fail:
```
dh_sphinxdoc: error: DOCUMENTATION_OPTIONS does not define URL_ROOT
```
The variable `DOCUMENTATION_OPTIONS` is directly set `layout.html` and
therefore `documentation_options.js` does not need to be included. So
just exclude it.
Signed-off-by: Benjamin Drung <benjamin.drung@ionos.com>
If patch file provided for file.patch state is malformed then state
returns `Patch was already applied` but patch is not applied.
ID: patch_example
Function: file.patch
Name: /tmp/example
Result: True
Comment: Patch was already applied
Started: 12:20:50.953163
Duration: 61.558 ms
Changes:
It is better to return error in such case.
ID: patch_example
Function: file.patch
Name: /tmp/example
Result: False
Comment: /usr/bin/patch: **** malformed patch at line 7:
Started: 12:33:44.915605
Duration: 59.202 ms
Changes:
Make better/more consistent use of rST features, such as:
- use "verbatim" for inline code/variables
- reference module functions using `:mod:`
- fix syntax (e.g. missing empty line before list)
Furthermore, improve the wording (prevent personal pronouns), spelling
(e.g. use upper-cased acronyms such as `CLI` or `POSIX`) and grammar.
