-
-
Notifications
You must be signed in to change notification settings - Fork 199
documentation for armbian/build#8811 - MANAGE_ACNG #835
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
Conversation
WalkthroughA new documentation entry for the Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes This is a straightforward documentation update affecting a single file. The changes involve adding descriptive content for a build configuration option without modifying code logic or existing documentation entries. Review requires basic verification that the documentation accurately describes the Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this 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
🧹 Nitpick comments (1)
docs/Developer-Guide_Build-Switches.md (1)
372-374: Restructure the second sub-bullet to match the established documentation pattern.The new MANAGE_ACNG entry deviates from the consistent format used for similar options like MAINLINE_MIRROR and DOWNLOAD_MIRROR. The second sub-bullet uses informal transition language ("but you can provide") instead of the
-value: descriptionstructure.Additionally,
http URLlacks backticks, unlikeyesandnoin the parameter specification.Apply this diff to align with the documented pattern:
- **MANAGE_ACNG** ( `yes` | **`no`** | http URL ): configures use of `apt-cacher-ng`, a cache for debian/ubuntu/etc apt repositories. + **MANAGE_ACNG** ( `yes` | **`no`** | `` `http URL` `` ): configures use of `apt-cacher-ng`, a cache for debian/ubuntu/etc apt repositories. - `yes` sets up an automatically managed `apt-cacher-ng` instance on the build host. This mode is incompatible with container builds. - - but you can provide a URL for a self-managed `apt-cacher-ng` instance, e.g. `"http://apt-cacher.example.com:3142"` + - `` `http URL` ``: provide a URL for a self-managed `apt-cacher-ng` instance, e.g. `http://apt-cacher.example.com:3142`Note: Also removed quotes around the URL example to be consistent with how URLs are shown in code blocks throughout the file.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/Developer-Guide_Build-Switches.md(1 hunks)
More or less what it says on the tin. Documents a previously existing but modified in armbian/build#8811 build switch.
yes/no/HTTP-URL