Bug 1181591

Summary: No Documentation= line in the sshd.service file
Product: Red Hat Enterprise Linux 7 Reporter: Karsten Weiss <knweiss>
Component: opensshAssignee: Jakub Jelen <jjelen>
Status: CLOSED ERRATA QA Contact: Stanislav Zidek <szidek>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.0CC: plautrba, riehecky, tmraz
Target Milestone: rcKeywords: Documentation
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: openssh-6.6.1p1-13.el7 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
: 1181593 (view as bug list) Environment:
Last Closed: 2015-11-19 08:02:35 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1181593, 1191021    

Description Karsten Weiss 2015-01-13 12:34:50 UTC
Description of problem:

There is no "Documentation=" line in "[Unit]" section of the
/usr/lib/systemd/service/sshd.service that references sshd's man pages.

That's why "systemctl status sshd.service" doesn't show the "Docs:"
section and "systemctl help sshd.service" doesn't open the man pages.

Version-Release number of selected component (if applicable):

openssh-server-6.4p1-8.el7.x86_64

How reproducible:

Query the sshd.service.

Steps to Reproduce:
1. systemctl status sshd.service
2. systemctl help sshd.service
3.

Actual results:

"systemctl status sshd.service" doesn't show a "Docs:" section

"systemctl help sshd.service" prints "Documentation for sshd.service not known." 


Expected results:

"systemctl status sshd.service" should show a "Docs:" section:
# systemctl status sshd.service
sshd.service - OpenSSH server daemon
   Loaded: loaded (/etc/systemd/system/sshd.service; enabled)
   Active: active (running) since Mon 2015-01-12 13:58:24 CET; 23h ago
     Docs: man:sshd(8)
           man:sshd_config(5)
[...]


"systemctl help sshd.service" should open the man pages.

Additional info:

The Documentation= line in sshd.service could look like this:

# cat sshd.service
[Unit]
Description=OpenSSH server daemon
Documentation=man:sshd(8) man:sshd_config(5)

The same applies to /usr/lib/systemd/service/sshd.socket.

Also, there are some other systemd unit files without a "Documentation=" line.
You should probably add a generic test for that.

Comment 6 errata-xmlrpc 2015-11-19 08:02:35 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://rhn.redhat.com/errata/RHSA-2015-2088.html