Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Please add Documentation= field in systemd .service files #722

Closed
bigon opened this issue Jul 27, 2019 · 1 comment · Fixed by #2733
Closed

Please add Documentation= field in systemd .service files #722

bigon opened this issue Jul 27, 2019 · 1 comment · Fixed by #2733
Labels
impacts-release-2.8.2 Issues reported against NUT release 2.8.2 (maybe vanilla or with minor packaging tweaks) packaging systemd
Milestone
2.8.3

Comments

@bigon
Copy link
Contributor

bigon commented Jul 27, 2019

Hi,

systemd .service files can add a reference to a man page with documentation about the daemon it starts (ie Documentation=man:upsd(8))

Would be nice if this was added
@jimklimov jimklimov added packaging impacts-release-2.8.2 Issues reported against NUT release 2.8.2 (maybe vanilla or with minor packaging tweaks) labels Apr 27, 2024
@jimklimov jimklimov added this to the 2.8.3 milestone Apr 27, 2024
@jimklimov
Copy link
Member

jimklimov commented Sep 23, 2024 •
edited
Loading

Per https://www.freedesktop.org/software/systemd/man/latest/systemd.unit.html

Documentation=

A space-separated list of URIs referencing documentation for this unit or its configuration. Accepted are only URIs of the types "http://", "https://", "file:", "info:", "man:". For more information about the syntax of these URIs, see uri(7). The URIs should be listed in order of relevance, starting with the most relevant. It is a good idea to first reference documentation that explains what the unit's purpose is, followed by how it is configured, followed by any other related documentation. This option may be specified more than once, in which case the specified list of URIs is merged. If the empty string is assigned to this option, the list is reset and all prior assignments will have no effect.

Added in version 201.

  • I think this would be best implemented as a mix of manually added links to man pages (perhaps right in the .in templates) and an URL generated to rolling NUT website (for branch builds) or specific "historic" release snapshot website (when building from a release tag).

  • Should configure check for systemd version (and/or support of the property?) given that v201 is Apr 2013? The oldest systemd-equipped Linux currently in NUT CI farm, CentOS 7, had systemd v234 already.

  • Wondering if usage()/help() methods of programs would benefit from a similar reference...

  • The nut-driver-enumerator should create similar entries when it creates service unit instances for each nut-driver@DEVICENAME.

  • Similar links make sense for SMF units (static and NDE-generated if possible).

jimklimov added a commit to jimklimov/nut that referenced this issue Dec 21, 2024
@jimklimov
configure.ac: derive NUT_WEBSITE_BASE from PACKAGE_URL [networkupstoo…
56f4f44 
…ls#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 21, 2024
@jimklimov
scripts/Solaris/*.xml.in: revise heading comments and documentation l…
a46ddab 
…inks [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 21, 2024
@jimklimov
scripts/systemd/nut* units: add documentation links [networkupstools#722
ac8ef47 
]

Signed-off-by: Jim Klimov <[email protected]>
@jimklimov jimklimov mentioned this issue Dec 21, 2024
Merged
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 22, 2024
@jimklimov
scripts/systemd/nut* units: add documentation links [networkupstools#722
1a8c0f2 
]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 22, 2024
@jimklimov
scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in: introduce *_setDocL…
6915fc2 
…ink() to refer to specific driver man pages, provide systemd implementation [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 23, 2024
@jimklimov
drivers/main.c: refer to local man (ifdef WITH_DOCS) and website page…
627ca70 
… for the driver [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 23, 2024
@jimklimov
common/common.c, include/common.h, drivers/main.c: introduce suggest_…
d1521b6 
…doc_links() [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 23, 2024
@jimklimov
server/sockdebug.c, server/pipedebug.c: refer to local man (ifdef WIT…
4757215 
…H_DOCS) and website page for these tools [networkupstools#722]

Reminder: both sources are built as `sockdebug` for different
platforms and share the man page.

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 23, 2024
@jimklimov
server/upsd.c: refer to local man (ifdef WITH_DOCS) and website page …
b583fcc 
…for the data server [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 23, 2024
@jimklimov
tools/nut-scanner/nut-scanner.c, tools/nut-scanner/Makefile.am: refer…
361db43 
… to local man (ifdef WITH_DOCS) and website page for this tool [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 23, 2024
@jimklimov
tools/nutconf/nutconf-cli.cpp: refer to local man (ifdef WITH_DOCS) a…
bef7376 
…nd website page for the nutconf tool [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 23, 2024
@jimklimov
clients/upsc.c, clients/upscmd.c, clients/upsrw.c, clients/upslog.c, …
aecc45c 
…clients/upsmon.c, clients/upssched.c: refer to local man (ifdef WITH_DOCS) and website page for these tools [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in: introduce *_setDocL…
a5dfaf5 
…ink() to refer to specific driver man pages, provide systemd implementation [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
drivers/main.c: refer to local man (ifdef WITH_DOCS) and website page…
0f543e7 
… for the driver [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
common/common.c, include/common.h, drivers/main.c: introduce suggest_…
26a20ba 
…doc_links() [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
server/sockdebug.c, server/pipedebug.c: refer to local man (ifdef WIT…
7489dae 
…H_DOCS) and website page for these tools [networkupstools#722]

Reminder: both sources are built as `sockdebug` for different
platforms and share the man page.

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
server/upsd.c: refer to local man (ifdef WITH_DOCS) and website page …
7eb9645 
…for the data server [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
tools/nut-scanner/nut-scanner.c, tools/nut-scanner/Makefile.am: refer…
1648070 
… to local man (ifdef WITH_DOCS) and website page for this tool [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
tools/nutconf/nutconf-cli.cpp: refer to local man (ifdef WITH_DOCS) a…
e9afd6a 
…nd website page for the nutconf tool [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
clients/upsc.c, clients/upscmd.c, clients/upsrw.c, clients/upslog.c, …
8c129fa 
…clients/upsmon.c, clients/upssched.c: refer to local man (ifdef WITH_DOCS) and website page for these tools [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in: refer to local man …
32a8462 
…and website pages for this tool [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
scripts/upsdrvsvcctl/upsdrvsvcctl.in: refer to local man and website …
e770866 
…pages for this tool [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
drivers/upsdrvctl.c: refer to local man (ifdef WITH_DOCS) and website…
ecb20b8 
… page for this tool [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 24, 2024
@jimklimov
common/common.c: suggest_doc_links(): do not preallocate buf2, ensure…
449a658 
… use of only basename of a program [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 25, 2024
@jimklimov
scripts/upsdrvsvcctl/nut-driver-enumerator.sh.in: smf_setDocLink(): c…
c1e09d4 
…omplete the proposed SMF implementation [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 25, 2024
@jimklimov
scripts/Windows/wininit.c: refer to local man (ifdef WITH_DOCS) and w…
de1d881 
…ebsite page for nut.exe wrapper [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
jimklimov added a commit to jimklimov/nut that referenced this issue Dec 25, 2024
@jimklimov
scripts/Windows/wininit.c: refer to local man (ifdef WITH_DOCS) and w…
54b3a7c 
…ebsite page for nut.exe wrapper [networkupstools#722]

Signed-off-by: Jim Klimov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
impacts-release-2.8.2 Issues reported against NUT release 2.8.2 (maybe vanilla or with minor packaging tweaks) packaging systemd
Projects
None yet
Milestone
2.8.3
Development

Successfully merging a pull request may close this issue.

Add documentation references to service units and program help jimklimov/nut
2 participants
@bigon @jimklimov