Skip to content

Add an --all-cores command line option to scons#16943

Merged
seanbudd merged 6 commits intonvaccess:masterfrom
LeonarddeR:fixJ0
Aug 2, 2024
Merged

Add an --all-cores command line option to scons#16943
seanbudd merged 6 commits intonvaccess:masterfrom
LeonarddeR:fixJ0

Conversation

@LeonarddeR
Copy link
Copy Markdown
Collaborator

@LeonarddeR LeonarddeR commented Aug 1, 2024 •
edited by coderabbitai bot
Loading

Link to issue number:

Fixup for #16868

Summary of the issue:

As part of #16868, i intended to implement support to pass a number of 0 cores to scons (e.g. scons source -j0) to automatically pick all available cores. It turns out that you cant override an option with SetOption when set on the command line.

Description of user facing changes

None, build system related.

Description of development approach

Added an --all-cores parameter that will pick all available cores.

Testing strategy:

Ensured that the build was marvelously faster when using the --all-cores parameter.

Known issues with pull request:

None known

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • New Features

    • Introduced a command-line option --all-cores for the build process, allowing users to utilize all available CPU cores for improved performance.
    • Updated documentation to guide users on using the --all-cores option in the scons build tool.

  • Bug Fixes

    • Improved documentation clarity by changing command parameters from -j0 to --all-cores.

  • Documentation

    • Enhanced user guidance on optimizing build performance with the new --all-cores parameter.

@LeonarddeR LeonarddeR requested a review from a team as a code owner August 1, 2024 17:45
@LeonarddeR LeonarddeR requested a review from seanbudd August 1, 2024 17:45
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 1, 2024 •
edited
Loading

Walkthrough

The recent updates enhance the build process by modifying the SCons command-line parameters across several components. The -j 0 option has been replaced with --all-cores, allowing users to utilize all available CPU cores, which can significantly improve performance. Documentation has been updated to reflect these changes, emphasizing the benefits and potential output issues when using the new option.

Changes

File Change Summary
.pre-commit-config.yaml Updated command-line entries for scons-source and checkPot hooks to use --all-cores.
projectDocs/dev/buildingNVDA.md Added documentation on using --all-cores with SCons, highlighting performance benefits and caveats.
sconstruct Implemented --all-cores option to allow maximum core utilization in the build process.
user_docs/en/changes.md Updated documentation to reflect the change from -j0 to --all-cores for clarity and usability.

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • 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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@AppVeyorBot
Copy link
Copy Markdown

AppVeyorBot commented Aug 1, 2024

See test results for failed build of commit deb3b7bb5e

@dpy013
Copy link
Copy Markdown
Contributor

dpy013 commented Aug 1, 2024

This feature is really good, but it doesn't showcase its performance on AppVeyor. Will it be faster using GitHub Actions?

@AppVeyorBot
Copy link
Copy Markdown

AppVeyorBot commented Aug 1, 2024

See test results for failed build of commit 5d74e8c733

@LeonarddeR
Copy link
Copy Markdown
Collaborator Author

LeonarddeR commented Aug 1, 2024

The primary reason why this is not used on appveyor is because it scrambles the output.

@SaschaCowley
Copy link
Copy Markdown
Member

SaschaCowley commented Aug 1, 2024

Note that you can set this to be the case always by adding -j N (where n is the number of cores you want to use) to the SCONSFLAGS environment variable. Providing -j N at the CLI will still override it for cases when you need to inspect the output. So for example, I have

PS D:\projects\nvda> echo $env:SCONSFLAGS
-j 16

seanbudd
seanbudd reviewed Aug 1, 2024
View reviewed changes
SaschaCowley
SaschaCowley requested changes Aug 1, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@SaschaCowley SaschaCowley left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this.

@seanbudd @SaschaCowley
Update sconstruct
54cfbf7 
Co-authored-by: Sascha Cowley <16543535+SaschaCowley@users.noreply.github.com>
@seanbudd seanbudd merged commit a498a26 into nvaccess:master Aug 2, 2024
@LeonarddeR LeonarddeR deleted the fixJ0 branch August 23, 2025 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seanbudd seanbudd seanbudd approved these changes

@SaschaCowley SaschaCowley SaschaCowley approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@LeonarddeR @AppVeyorBot @dpy013 @SaschaCowley @seanbudd