docs(quickstart-guide): update bandwidth-limit rationale to match README - #94
Merged
Merged
Conversation
The Connection Speed section's recommendation and math examples
were outdated:
- Recommended setting only the upload cap ("You don't need to set
a maximum download speed") while aMule actually ships with
MaxUpload=0 AND MaxDownload=0 (literal-unlimited since the
throttler rewrites in 3.0.0). On a connection aMule can
saturate, the unlimited-download default starves every other
application on the link.
- Math example used an old 1024 kb/s / 512 kb/s ADSL profile and
the "divide by 8 to get kB/s from kb/s" formulation. Modern
fibre is the more realistic baseline, and ISP marketing is
almost always in Mbps (not kb/s) today.
Align with the README's "Set bandwidth limits" subsection (PR
amule-project/amule#527):
- Surface the unlimited defaults explicitly, with the
link-starvation rationale plus the TCP-ACK angle for uncapped
uploads.
- Recommend setting both upload and download to ~80% of line
speed.
- Replace the kb/s ÷ 8 math with Mbps × 125, and the example
with a 100/20 Mbps fibre line.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Aligns the Connection Speed section of the quickstart guide with the bandwidth-limit rationale in the main aMule README (added in amule-project/amule#527).
Why
The current section recommends setting only the upload cap ("You don't need to set a maximum download speed"), but aMule actually ships with
MaxUpload=0ANDMaxDownload=0— both interpreted as literal unlimited since the throttler rewrites in 3.0.0. On a connection that aMule can saturate, the unlimited-download default starves every other application sharing the link.The math example also used an old 1024 kb/s / 512 kb/s ADSL profile and a
÷ 8formulation assuming the reader already converted Mbps to kb/s. Modern fibre is the more realistic baseline, and ISP marketing is almost always in Mbps today —Mbps × 125 = kB/sis the one-step conversion.Changes
MaxUpload=0/MaxDownload=0) and the link-starvation rationale.÷ 8from kb/s →× 125from Mbps.The existing intro about ED2K's upload/download enforcement is kept as-is — it's accurate.