RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1184118 - No Documentation= lines in the httpd.service and htcacheclean.service files
Summary: No Documentation= lines in the httpd.service and htcacheclean.service files
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: httpd
Version: 7.0
Hardware: All
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Luboš Uhliarik
QA Contact: Martin Frodl
URL:
Whiteboard:
Depends On:
Blocks: 1641951
TreeView+ depends on / blocked
 
Reported: 2015-01-20 15:31 UTC by Karsten Weiss
Modified: 2021-01-14 09:33 UTC (History)
2 users (show)

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.
Clone Of:
: 1641951 (view as bug list)
Environment:
Last Closed: 2015-11-19 04:37:19 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2015:2194 0 normal SHIPPED_LIVE httpd bug fix and enhancement update 2015-11-19 08:05:27 UTC

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


Note You need to log in before you can comment on or make changes to this bug.