Add CPUTHREADS Build Switch

[Grippy98]

Documentation to match armbian/build#8346

Documentation website preview will be available shortly:

 Open WWW preview 

[coderabbitai]

Walkthrough

The documentation file docs/Developer-Guide_Build-Switches.md was updated to include information about a new build parameter named CPUTHREADS. This parameter allows users to specify the number of compilation threads to use during the build process, overriding the default value. If CPUTHREADS is not set, the system defaults to using 150% of the available CPU threads. The documentation update places this information in the "Advanced" section and describes the parameter's expected behavior and fallback mechanism.

Suggested labels

Needs review, size/small, Ready to merge

Suggested reviewers

• igorpecovnik

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in a Comment
• Commit Unit Tests in branch CPUTHREADS

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/Developer-Guide_Build-Switches.md (3)

261-261: Use the correct type hint – this should be integer, not string.

Everywhere else we document numeric build switches as integer (e.g. SECTOR_SIZE). Marking CPUTHREADS as string is misleading because only a positive integer is valid.

-**CPUTHREADS** ( `string` )
+**CPUTHREADS** ( `integer` )

---

263-265: Minor grammar & casing fix for the default-value sentence.

-If not defined, defaults to 150% the number of CPU Threads available to maximize compilation speed.
+If not defined, defaults to 150 % of the number of CPU threads available to maximise compilation speed.

---

261-266: Add a short usage example for consistency with neighbouring switches.

Most switches in this section provide a concrete ./compile.sh … snippet; adding one here makes the docs scan-friendly.

@@
 Allows the user to override CTHREADS if CPUTHREADS is defined and a valid positive integer.

 If not defined, defaults to 150% of the number of CPU threads available to maximize compilation speed.

+Example:
+
+```sh
+./compile.sh CPUTHREADS=8
+```

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3ead825 and bb91f4d.

📒 Files selected for processing (1)

• docs/Developer-Guide_Build-Switches.md (1 hunks)

🔇 Additional comments (1)

docs/Developer-Guide_Build-Switches.md (1)

261-266: Confirm the variable name matches the implementation.

The description states it “overrides CTHREADS”. Please double-check that the build scripts actually read CPUTHREADS (and not e.g. CPU_THREADS or CTHREADS) to avoid a documentation/implementation drift.

[igorpecovnik]

add string values here too