Skip to content

docs: Docs buffer overrun improvement #3986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

erikmagkekse
Copy link

Description

Just a small documentation improvement with example code how traffic shaping could be done on a OS Level.
I troubleshooted that issue for many hours, found out about this helpful page but didn't found any examples. I think that will be helpful for many other users too.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Copy link

@erikmagkekse erikmagkekse changed the title Docs buffer overrun improvement docs: Docs buffer overrun improvement Jun 19, 2025
@ReenigneArcher
Copy link
Member

@gschintgen could you review this as you originally added this section to the docs?

Copy link
Member

@ReenigneArcher ReenigneArcher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few suggestions below to improve the spacing and syntax highlighting.

Comment on lines +91 to +93
Such a solution on Linux could look like that:
```
# 1) Remove existing qdisc (pfifo_fast)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Such a solution on Linux could look like that:
```
# 1) Remove existing qdisc (pfifo_fast)
Such a solution on Linux could look like that:
```bash
# 1) Remove existing qdisc (pfifo_fast)

u32 match ip protocol 17 0xff \
match ip sport 47998 0xffff flowid 1:10
```
In that way only the Sunshine traffic is limited by 1 Gbit. This is not persistent on reboots.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In that way only the Sunshine traffic is limited by 1 Gbit. This is not persistent on reboots.
In that way only the Sunshine traffic is limited by 1 Gbit. This is not persistent on reboots.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants