| |
- Systemd in Fedora 17+ has support for defining documentation in unit files via the Documentation= field (it is ignored in older releases, so it is safe to keep one systemd unit file across all branches). System administrators will be looking at the contents of the Documentation= field to determine what the service is, how to configure it, and where to locate additional documentation relating to the service. Accordingly, packagers are strongly encouraged to include any available sources in the Documentation= field which provide this information. If a man page or info page is present in the package, refer to it using "man:manpage" or "info:infofile" respectively. If the documentation is in plaintext, use "file://path/to/file". Lastly, if no local documentation exists in the package, but it exists at a URL, use the URL (with http://) in this field. Multiple URIs can be added to the Documentation= field, as a space separated list. For details on URI definitions and formatting, please refer to the uri(7) manpage (man uri).
|
| |
+ Systemd in Fedora 17+ has support for defining documentation in unit files via the `Documentation=` field (it is ignored in older releases, so it is safe to keep one systemd unit file across all branches). System administrators will be looking at the contents of the `Documentation=` field to determine what the service is, how to configure it, and where to locate additional documentation relating to the service. Accordingly, packagers are strongly encouraged to include any available sources in the `Documentation=` field which provide this information. If a man page or info page is present in the package, refer to it using `man:manpage` or `info:infofile` respectively. If the documentation is in plaintext, use `\file://path/to/file`. Lastly, if no local documentation exists in the package, but it exists at a URL, use the URL (with `http://`) in this field. Multiple URIs can be added to the `Documentation=` field, as a space separated list. For details on URI definitions and formatting, please refer to the `uri(7)` manpage (`man uri`).
|
pbokoc
commented 3 years ago
The "Documentation field" section of the Systemd doc is currently failing to render due to the presence of
file://andhttp://in plaintext - see https://docs.fedoraproject.org/en-US/packaging-guidelines/Systemd/#_documentation_field. This PR fixes that and adds proper markup for the whole section.