Bug 1184118

Summary: No Documentation= lines in the httpd.service and htcacheclean.service files
Product: Red Hat Enterprise Linux 7 Reporter: Karsten Weiss <knweiss>
Component: httpdAssignee: Luboš Uhliarik <luhliari>
Status: CLOSED ERRATA QA Contact: Martin Frodl <mfrodl>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.0CC: isenfeld, jkaluza
Target Milestone: rc   
Target Release: ---   
Hardware: All   
OS: Unspecified   
Whiteboard:
Fixed In Version: httpd-2.4.6-32.el7 Doc Type: Bug Fix
Doc Text:
Cause: httpd.service and htcacheclean.service files did not containct Documentation directives. Consequence: When calling "systemctl status httpd.service" or "systemctl help httpd.service", the httpd documentation was not referenced. Fix: Documentation directives have been added into service files. Result: Previously mentioned systemctl commands contains reference to documentation.
Story Points: ---
Clone Of:
: 1641951 (view as bug list) Environment:
Last Closed: 2015-11-19 04:37:19 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: 1641951    

Description Karsten Weiss 2015-01-20 15:31:31 UTC
Description of problem:

There is no "Documentation=" line in "[Unit]" section of the
/usr/lib/systemd/service/httpd.service that references the man pages or
documentation files. Same for htcacheclean.service.

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

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

httpd-2.4.6-19.el7

How reproducible:

Query the httpd.service.

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

Actual results:

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

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


Expected results:

"systemctl status httpd.service" should show a "Docs:" section:

# systemctl status httpd.service
httpd.service - The Apache HTTP Server
   Loaded: loaded (/etc/systemd/system/httpd.service; enabled)
   Active: active (running) since Tue 2015-01-20 17:16:48 CET; 4min 14s ago
     Docs: man:httpd(8)
           man:apachectl(8)
 Main PID: 7657 (httpd)
   Status: "Total requests: 0; Current requests/sec: 0; Current traffic:   0 B/sec"
   CGroup: /system.slice/httpd.service
[...]

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

Additional info:

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

# grep ^Documentation= httpd.service 
Documentation=man:httpd(8)
Documentation=man:apachectl(8)

The same applies to /usr/lib/systemd/service/htcacheclean.service:

# grep ^Documentation= htcacheclean.service 
Documentation=man:htcacheclean(8)

There are some other systemd unit files without a "Documentation=" line.
You should really consider a generic unit file check for the entire distribution.

Also, a systemd-lint utility would be awesome.

Comment 7 errata-xmlrpc 2015-11-19 04:37:19 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/RHBA-2015-2194.html