Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 291907 - sys-apps/iproute2: HFSC documentation missing
Summary: sys-apps/iproute2: HFSC documentation missing
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo's Team for Core System packages
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-11-04 20:28 UTC by Arthur D.
Modified: 2009-12-06 08:11 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
This will add missing documentation to HFSC class (iproute2-hfsc-doc.patch.bz2,15.43 KB, patch)
2009-11-04 20:30 UTC, Arthur D.
Details | Diff
Removed excessive .swp file (iproute-hfsc-doc-r1.patch.bz2,12.16 KB, patch)
2009-11-04 20:40 UTC, Arthur D.
Details | Diff
Little fix to Makefile (iproute-hfsc-doc-r2.patch,36.22 KB, patch)
2009-11-04 20:58 UTC, Arthur D.
Details | Diff
The patch adds detailed documentation for HFSC scheduler (iproute2-hfsc-doc-r3.patch.bz2,12.80 KB, application/octet-stream)
2009-11-29 18:23 UTC, Arthur D.
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Arthur D. 2009-11-04 20:28:01 UTC
There's HFSC QOS discipline in kernel.
This one is not documented at all.
There's no meaningful documentation over Internet as well.

Reproducible: Always

Steps to Reproduce:
1. emerge iproute2 
2. man tc-hfsc
Actual Results:  
Error message:
No manual entry for tc-hfsc

Expected Results:  
Manual page shown
Comment 1 Arthur D. 2009-11-04 20:30:48 UTC
Created attachment 209265 [details, diff]
This will add missing documentation to HFSC class

The patch was adapted to current iproute2 extracted from today's git.
Comment 2 Arthur D. 2009-11-04 20:40:33 UTC
Created attachment 209268 [details, diff]
Removed excessive .swp file
Comment 3 Arthur D. 2009-11-04 20:58:39 UTC
Created attachment 209270 [details, diff]
Little fix to Makefile
Comment 4 SpanKY gentoo-dev 2009-11-05 12:02:06 UTC
post the exact git commit's (by their sha1 id) that you want imported
Comment 5 Arthur D. 2009-11-05 12:10:31 UTC
> post the exact git commit's (by their sha1 id) that you want imported

What do you mean? The patch was made by me.
It's applied fine on current iproute2 stable package.
Comment 6 SpanKY gentoo-dev 2009-11-29 15:46:23 UTC
your "little fix" contains a bunch of changes unrelated to documentation.  if you arent taking the changes from upstream, then they need to be posted to the upstream mailing list.
Comment 7 Arthur D. 2009-11-29 15:57:15 UTC
Please check the header of the patch.
A full description is in place.

That's strange, you call one little fix to be "a bunch of changes":
s->mtu = 2047;		->	s->mtu = 2048;
while ((s->mtu >> s->cell_log) > s->tsize - 1)	->  while ((s->mtu - 1 >> s->cell_log) > s->tsize - 1)

All other changes are documentation related.

If you feel bad about that change to sources,
just omit it (this fix was done by the author of documentation, you may see
this if you read the header of the patch).
Comment 8 SpanKY gentoo-dev 2009-11-29 17:49:58 UTC
there is no "header of the patch" that indicates anything at all about who is making the changes or where you got them.  you called the patch "little fix to makefile" when in reality it adds a man page, changes a makefile, makes undocumented changes to mtu values, and changes usage output in multiple files.

i'm not throwing random patches into the tree without info on where they're coming from and why they're needed
Comment 9 Arthur D. 2009-11-29 18:23:01 UTC
Created attachment 211530 [details]
The patch adds detailed documentation for HFSC scheduler

The headers are back
Comment 10 Arthur D. 2009-11-29 18:25:18 UTC
(In reply to comment #8)
> there is no "header of the patch" that indicates anything at all about who is
> making the changes or where you got them.
Sorry that was my mistake... Fixed in last attachment.
> you called the patch "little fix to makefile"
That was the description of the change (like Changelog entry) I made to previous patch.
Comment 11 SpanKY gentoo-dev 2009-12-06 08:11:47 UTC
thanks, that documented patch i'm happy to take.  it's in 2.6.29.1-r3 now.