Bug 641918

Summary: man ss refers to a non-existent file
Product: Red Hat Enterprise Linux 6 Reporter: Patrick C. F. Ernzer <pcfe>
Component: iprouteAssignee: Petr Šabata <psabata>
Status: CLOSED ERRATA QA Contact: BaseOS QE Security Team <qe-baseos-security>
Severity: low Docs Contact:
Priority: low    
Version: 6.0CC: greenrd, mmaslano, psabata, rvokal, syeghiay
Target Milestone: rcKeywords: Documentation, Patch
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: iproute-2.6.32-11.el6 Doc Type: Bug Fix
Doc Text:
The ss man page contained a reference to a nonexistent file. This reference has been updated with the correct file location.
Story Points: ---
Clone Of: 641599 Environment:
Last Closed: 2011-05-19 14:23:30 UTC Type: ---
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: 641599    
Bug Blocks: 494837    
Attachments:
Description Flags
ss documentation manpage patch
none
Updated patch for ss.8 and iproute.spec none

Description Patrick C. F. Ernzer 2010-10-11 14:17:50 UTC
+++ This bug was initially created as a clone of Bug #641599 +++

Description of problem:
In the iproute man page, it says:

 SEE ALSO
       ip(8), /usr/share/doc/iproute-doc/ss.html (package iproute­doc)

Neither this file, nor the package mentioned after it, exists. There is a package iproute-doc, but it does not contain this file!

It does contain a file ss.ps, but since this file (from 2001) advises the user not to use ss and use netstat instead, and the netstat man page *clearly* states than netstat is obsolete and ss is its replacement, I am not sure that ss.ps (in its current state) is the right file to refer to either!

Version-Release number of selected component (if applicable):
iproute-2.6.33-4.fc13.i686

--- Additional comment from psabata on 2010-10-11 08:18:06 EDT ---

Robin,

I don't see the 'iproutedoc' (without the dash) mentioned anywhere in iproute manpages. The ss.html file mentioned in ss(8) truly doesn't exist, ss.ps is generated instead. This will be corrected.

Netstat is from the net-tools package which is generally considered obsolete -- and iproute2 its replacement; I'd believe the note in netstat(8) (from 2000, by the way). Concerning the ss documentation, this is, sadly, the latest version available in the upstream.

Petr

--- Additional comment from greenrd on 2010-10-11 08:34:03 EDT ---

Sorry, I meant the ss man page, not the iproute man page, above.

--- Additional comment from psabata on 2010-10-11 09:06:09 EDT ---

I also see a different dash character was used (0xAD instead of regular 0x2D) in the 'iproute-doc' word. Updating that as well.

--- Additional comment from updates on 2010-10-11 09:13:27 EDT ---

iproute-2.6.33-6.fc13 has been submitted as an update for Fedora 13.
https://admin.fedoraproject.org/updates/iproute-2.6.33-6.fc13

--- Additional comment from updates on 2010-10-11 09:14:00 EDT ---

iproute-2.6.35-4.fc14 has been submitted as an update for Fedora 14.
https://admin.fedoraproject.org/updates/iproute-2.6.35-4.fc14

Comment 1 Patrick C. F. Ernzer 2010-10-11 14:18:16 UTC
in el6, the affected package is iproute-2.6.32-10.el6.i686

Comment 2 Petr Šabata 2010-10-12 09:33:10 UTC
Created attachment 452919 [details]
ss documentation manpage patch

Comment 3 Petr Šabata 2010-11-09 12:43:15 UTC
Created attachment 459092 [details]
Updated patch for ss.8 and iproute.spec

Comment 9 Petr Šabata 2011-01-26 18:15:44 UTC
Fix included in CVS iproute-2.6.32-11.el6

Comment 12 Laura Bailey 2011-05-11 07:24:17 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
The ss man page contained a reference to a nonexistent file. This reference has been updated with the correct file location.

Comment 13 errata-xmlrpc 2011-05-19 14:23:30 UTC
An advisory has been issued which should help the problem
described in this bug report. This report is therefore being
closed with a resolution of ERRATA. For more information
on therefore solution and/or where to find the updated files,
please follow the link below. You may reopen this bug report
if the solution does not work for you.

http://rhn.redhat.com/errata/RHBA-2011-0757.html