[Bug 1668813] Re: The tc man page references tc-index man page but tc-index man page does not exist

[Jon Grimm]

** Description changed:

- The tc man page references tc-index man page but tc-index man page does
- not exist.
+ [Impact]
  
- The tc-index man page is incorrectly named tcindex.
+  * The man pages for tc make reference to a non-existent tc-index man
+ page. Purely a typo that should have been tc-tcindex.
  
- This is on Xenial, using package version 4.3.0-1ubuntu3 of iproute2
+  *  Purely a documentation fix, but nice to fix for an LTS release that
+ has many years left to it.
+ 
+ 
+ [Test Case]
+ 
+  * To see this issue, fire up a 16,04 image (I did so via lxd) and type:
+ 
+    root at xi386# man tc | grep tc-index
+                  Filter packets based on traffic control index. See tc-index(8).
+ 
+ , HOWEVER:
+ 
+    root at xi386:~# man tc-index
+    No manual entry for tc-index
+ 
+ 
+ * on a fixed system you should only see refereces to tc-tcindex, not tc-index:
+ 
+    root at x1:~# man tc | grep tc-index
+    root at x1:~# man tc | grep tc-tcindex
+                  Filter packets based on traffic control index. See tc-tcindex(8).
+           red(8), tc-route(8), tc-sfb(8), tc-sfq(8), tc-stab(8), tc-tbf(8), tc-tcindex(8), tc-u32(8),
+ 
+ 
+ 
+ [Regression Potential] 
+ 
+  * This is only a change to man pages, so any regression would be non-
+ functional, but this fix is trivial to fix and verify, and the fix is
+ exactly from the upstream.

-- 
You received this bug notification because you are a member of Ubuntu
Sponsors Team, which is subscribed to the bug report.
https://bugs.launchpad.net/bugs/1668813

Title:
  The tc man page references tc-index man page but tc-index man page
  does not exist

Status in iproute2 package in Ubuntu:
  Fix Released
Status in iproute2 source package in Xenial:
  In Progress
Status in iproute2 source package in Yakkety:
  In Progress

Bug description:
  [Impact]

   * The man pages for tc make reference to a non-existent tc-index man
  page. Purely a typo that should have been tc-tcindex.

   *  Purely a documentation fix, but nice to fix for an LTS release
  that has many years left to it.

  
  [Test Case]

   * To see this issue, fire up a 16,04 image (I did so via lxd) and
  type:

     root at xi386# man tc | grep tc-index
                   Filter packets based on traffic control index. See tc-index(8).

  , HOWEVER:

     root at xi386:~# man tc-index
     No manual entry for tc-index

  
  * on a fixed system you should only see refereces to tc-tcindex, not tc-index:

     root at x1:~# man tc | grep tc-index
     root at x1:~# man tc | grep tc-tcindex
                   Filter packets based on traffic control index. See tc-tcindex(8).
            red(8), tc-route(8), tc-sfb(8), tc-sfq(8), tc-stab(8), tc-tbf(8), tc-tcindex(8), tc-u32(8),


  
  [Regression Potential] 

   * This is only a change to man pages, so any regression would be non-
  functional, but this fix is trivial to fix and verify, and the fix is
  exactly from the upstream.

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/iproute2/+bug/1668813/+subscriptions