sqm-scripts icon indicating copy to clipboard operation
sqm-scripts copied to clipboard

Update simplest_tbf.qos.help

Open diogosena opened this issue 1 year ago • 5 comments

Clarify that fq_codel is mandatory when using this script.

diogosena avatar Dec 18 '23 18:12 diogosena

It's not strictly speaking true that fq_codel is the only supported qdisc; rather, cake is explicitly not supported, so selecting that will cause a reset to fq_codel. So if we're updating the documentation it should be to say that cake is not supported...

tohojo avatar Dec 21 '23 17:12 tohojo

It's not strictly speaking true that fq_codel is the only supported qdisc; rather, cake is explicitly not supported, so selecting that will cause a reset to fq_codel. So if we're updating the documentation it should be to say that cake is not supported...

In the header of the script itself, it is explicitly stated that the script is an fq_codel script:

# This is a single band fq_codel and ipv6 enabled shaping script for Ethernet
# gateways. This is nearly the simplest possible. With FQ_CODEL, the sparseness

diogosena avatar Dec 21 '23 19:12 diogosena

diogosena @.***> writes:

It's not strictly speaking true that fq_codel is the only supported qdisc; rather, cake is explicitly not supported, so selecting that will cause a reset to fq_codel. So if we're updating the documentation it should be to say that cake is not supported...

In the header of the script itself, it is explicitly stated that the script is an fq_codel script:

# This is a single band fq_codel and ipv6 enabled shaping script for Ethernet
# gateways. This is nearly the simplest possible. With FQ_CODEL, the sparseness

Sure, but it is not actually required. And the script only enforces it if cake is selected as the qdisc. You could run it with, say, sfq and that would work just fine (not that I'd recommend that, of course!).

So we could write something like "It is recommended to use fq_codel as the qdisc for this script; if selecting cake as the qdisc, fq_codel will be automatically used instead."

tohojo avatar Jan 12 '24 16:01 tohojo

diogosena @.***> writes:

It's not strictly speaking true that fq_codel is the only supported qdisc; rather, cake is explicitly not supported, so selecting that will cause a reset to fq_codel. So if we're updating the documentation it should be to say that cake is not supported... In the header of the script itself, it is explicitly stated that the script is an fq_codel script: # This is a single band fq_codel and ipv6 enabled shaping script for Ethernet # gateways. This is nearly the simplest possible. With FQ_CODEL, the sparseness Sure, but it is not actually required. And the script only enforces it if cake is selected as the qdisc. You could run it with, say, sfq and that would work just fine (not that I'd recommend that, of course!). So we could write something like "It is recommended to use fq_codel as the qdisc for this script; if selecting cake as the qdisc, fq_codel will be automatically used instead."

maybe this? just trying to keep similar to other scripts help.

"This script forces fq_codel usage if cake is selected as qdisc."

diogosena avatar Jan 12 '24 18:01 diogosena

diogosena @.***> writes:

maybe this? just trying to keep similar to other scripts help.

"This script forces fq_codel usage if cake is selected as qdisc."

Sure, that works!

tohojo avatar Jan 17 '24 16:01 tohojo