Skip to content
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

fix: make check-bbr #4004

Merged
merged 4 commits into from
Oct 29, 2024
Merged

fix: make check-bbr #4004

merged 4 commits into from
Oct 29, 2024

Conversation

evan-forbes
Copy link
Member

Overview

very minor fix that fixes the check-bbr command

@evan-forbes evan-forbes added the bug Something isn't working label Oct 23, 2024
@evan-forbes evan-forbes self-assigned this Oct 23, 2024
@evan-forbes evan-forbes requested review from liamsi and a team as code owners October 23, 2024 21:31
@evan-forbes evan-forbes requested review from rootulp and ninabarbakadze and removed request for a team October 23, 2024 21:31
@celestia-bot celestia-bot requested a review from a team October 23, 2024 21:32
@evan-forbes evan-forbes requested review from cmwaters and rach-id and removed request for a team October 23, 2024 21:32
@evan-forbes evan-forbes changed the base branch from main to evan/fix-bbr October 23, 2024 21:33
Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes include updates to the Makefile, README.md, and release-notes.md. In the Makefile, the syntax for variable substitution in the check-bbr target was corrected. The README.md now reflects a change in the command for enabling the BBR congestion control algorithm and clarifies usage as a library. The release notes have been enhanced with additional instructions for enabling BBR and updates regarding the relocation of constants in version 3.0.0.

Changes

File Change Summary
Makefile Updated the check-bbr target to correct variable substitution syntax and adjusted output formatting.
README.md Modified command from make use-bbr to make enable-bbr and clarified usage as a library.
docs/release-notes/release-notes.md Added instructions for enabling BBR on various platforms and noted relocation of constants in version 3.0.0.

Possibly related PRs

Suggested labels

testing

Suggested reviewers

  • rootulp
  • cmwaters
  • ninabarbakadze
  • staheri14

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
docs/release-notes/release-notes.md (1)

10-10: LGTM with a minor formatting suggestion.

The added instructions for BBR configuration are clear and accurate. However, for consistency with other bullet points in the document, consider capitalizing the first word.

-  - if using linux in docker, kubernetes, a vm or baremetal, this can be done by calling the `make enable-bbr` command on the host machine.
+  - If using Linux in Docker, Kubernetes, a VM or bare metal, this can be done by calling the `make enable-bbr` command on the host machine.
README.md (1)

Line range hint 87-94: Consider adding a note about system requirements.

While the instructions are clear, it would be helpful to explicitly mention that BBR configuration requires root/sudo access and is primarily for Linux systems. This could prevent confusion for users on other operating systems.

Consider adding a note like:

If not, enable it on Linux by calling the `make enable-bbr` or by running:
+ > Note: These commands require root/sudo access and are specific to Linux systems.
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 312def6 and a8db5b4.

📒 Files selected for processing (3)
  • Makefile (1 hunks)
  • README.md (1 hunks)
  • docs/release-notes/release-notes.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
README.md (1)

87-87: LGTM! Clear and consistent command update.

The change from make use-bbr to make enable-bbr is well documented and provides both the make command and manual steps for users who need to enable BBR congestion control.

Makefile (1)

254-257: LGTM! Fixed Makefile variable substitution syntax.

The change correctly escapes the awk variable $3 to $$3 in the Makefile context. This is necessary because Make interprets single $ as its own variable reference, while we want to pass the literal $3 to the awk command. The fix ensures that the BBR congestion control algorithm check works as intended.

cmwaters
cmwaters previously approved these changes Oct 24, 2024
Copy link
Contributor

@cmwaters cmwaters left a comment

Choose a reason for hiding this comment

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

utAck

rach-id
rach-id previously approved these changes Oct 24, 2024
Base automatically changed from evan/fix-bbr to main October 24, 2024 11:55
@evan-forbes evan-forbes dismissed stale reviews from rach-id and cmwaters October 24, 2024 11:55

The base branch was changed.

@celestia-bot celestia-bot requested a review from a team October 24, 2024 14:31
@evan-forbes evan-forbes enabled auto-merge (squash) October 24, 2024 14:31
@evan-forbes evan-forbes added the backport:v2.x PR will be backported automatically to the v2.x branch upon merging label Oct 28, 2024
Copy link
Member

@ninabarbakadze ninabarbakadze left a comment

Choose a reason for hiding this comment

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

utAck

@celestia-bot celestia-bot requested a review from a team October 28, 2024 21:53
Copy link
Contributor

@cmwaters cmwaters left a comment

Choose a reason for hiding this comment

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

re-utAck

@evan-forbes evan-forbes merged commit c410d88 into main Oct 29, 2024
31 checks passed
@evan-forbes evan-forbes deleted the evan/fix-check-bbr branch October 29, 2024 17:05
mergify bot pushed a commit that referenced this pull request Oct 29, 2024
## Overview

very minor fix that fixes the `check-bbr` command

(cherry picked from commit c410d88)

# Conflicts:
#	Makefile
evan-forbes added a commit that referenced this pull request Oct 30, 2024
## Overview

very minor fix that fixes the `check-bbr` command
<hr>This is an automatic backport of pull request #4004 done by
[Mergify](https://mergify.com).

---------

Co-authored-by: Evan Forbes <[email protected]>
Co-authored-by: evan-forbes <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:v2.x PR will be backported automatically to the v2.x branch upon merging bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants