Bug 1181593

Summary: No Documentation= line in the sshd.service file
Product: [Fedora] Fedora Reporter: Petr Lautrbach <plautrba>
Component: opensshAssignee: Petr Lautrbach <plautrba>
Status: CLOSED ERRATA QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 20CC: jjelen, knweiss, lnie, mattias.ellert, mgrepl, plautrba, qe-baseos-security, tmraz
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: openssh-6.4p1-8.fc20 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: 1181591 Environment:
Last Closed: 2015-02-03 12: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: 1181591    
Bug Blocks:    
Attachments:
Description Flags
Proposed dist git patch none

Description Petr Lautrbach 2015-01-13 12:37:11 UTC
+++ This bug was initially created as a clone of Bug #1181591 +++

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 1 Jakub Jelen 2015-01-13 16:57:19 UTC
Created attachment 979677 [details]
Proposed dist git patch

I think this feature can be easily added and does his job to get help about services in standardized way.

Comment 2 Fedora Update System 2015-01-15 14:34:16 UTC
openssh-6.6.1p1-11.1.fc21 has been submitted as an update for Fedora 21.
https://admin.fedoraproject.org/updates/openssh-6.6.1p1-11.1.fc21

Comment 3 Fedora Update System 2015-01-15 15:03:31 UTC
openssh-6.4p1-8.fc20 has been submitted as an update for Fedora 20.
https://admin.fedoraproject.org/updates/openssh-6.4p1-8.fc20

Comment 4 lnie 2015-01-16 08:07:15 UTC
openssh-6.6.1p1-11.1.fc21 works

Comment 5 Fedora Update System 2015-01-17 05:40:06 UTC
Package openssh-6.4p1-8.fc20:
* should fix your issue,
* was pushed to the Fedora 20 testing repository,
* should be available at your local mirror within two days.
Update it with:
# su -c 'yum update --enablerepo=updates-testing openssh-6.4p1-8.fc20'
as soon as you are able to.
Please go to the following url:
https://admin.fedoraproject.org/updates/FEDORA-2015-0756/openssh-6.4p1-8.fc20
then log in and leave karma (feedback).

Comment 6 Fedora Update System 2015-01-17 23:55:32 UTC
openssh-6.6.1p1-11.1.fc21 has been pushed to the Fedora 21 stable repository.  If problems still persist, please make note of it in this bug report.

Comment 7 Fedora Update System 2015-02-03 12:02:35 UTC
openssh-6.4p1-8.fc20 has been pushed to the Fedora 20 stable repository.  If problems still persist, please make note of it in this bug report.