Sponsored Content
Skip to content

docs: Add --parallel flag to cmake build commands in BUILD.md - #7302

Merged
bthomee merged 2 commits into
XRPLF:developfrom
ricky122-5:ricky122-5/update-docs-build-md
May 21, 2026
Merged

docs: Add --parallel flag to cmake build commands in BUILD.md#7302
bthomee merged 2 commits into
XRPLF:developfrom
ricky122-5:ricky122-5/update-docs-build-md

Conversation

@ricky122-5

Copy link
Copy Markdown
Contributor

High Level Overview of Change

Added the --parallel N flag to the cmake --build commands in BUILD.md to document how to speed up builds using parallel jobs.

Context of Change

The build documentation didn't mention the --parallel flag, which is a common way to significantly reduce build times. This is a documentation-only change with no code impact.

API Impact

No impact. Only a documentation change.

  • Public API: New feature (new methods and/or new fields)
  • Public API: Breaking change (in general, breaking changes should only impact the next api_version)
  • libxrpl change (any change that may affect libxrpl or dependents of libxrpl)
  • Peer protocol change (must be backward compatible or bump the peer protocol version)

@github-actions

Copy link
Copy Markdown

⚠️ This PR contains unsigned commits. To get your PR merged, please sign them. ⚠️

If only the most recent commit is unsigned, you can run:

  1. Amend the commit: git commit --amend --no-edit -n -S
  2. Overwrite the commit: git push --force-with-lease

If multiple commits are unsigned, you can run:

  1. Go into interactive rebase mode: git rebase --interactive HEAD~<NUM_OF_COMMITS>, where NUM_OF_COMMITS is the number of most recent commits that will be available to edit.
  2. Change "pick" to "edit" for the commits you need to sign, and then save and exit.
  3. For each commit, run: git commit --amend --no-edit -n -S
  4. Continue the rebase: git rebase --continue
  5. Overwrite the commit(s): git push --force-with-lease

If you're new to commit signing, there are different ways to set it up:

Sign commits with gpg

Follow the steps below to set up commit signing with gpg:

  1. Generate a GPG key
  2. Add the GPG key to your GitHub account
  3. Configure git to use your GPG key for commit signing
Sign commits with ssh-agent

Follow the steps below to set up commit signing with ssh-agent:

  1. Generate an SSH key and add it to ssh-agent
  2. Add the SSH key to your GitHub account
  3. Configure git to use your SSH key for commit signing
Sign commits with 1Password

You can also sign commits using 1Password, which lets you sign commits with biometrics without the signing key leaving the local 1Password process.
See use 1Password to sign your commits.

@mvadari mvadari added the Trivial Simple change with minimal effect, or already tested. Only needs one approval. label May 20, 2026
@ricky122-5
ricky122-5 force-pushed the ricky122-5/update-docs-build-md branch from 251c9c2 to d4c8934 Compare May 20, 2026 19:53
@mvadari

mvadari commented May 20, 2026

Copy link
Copy Markdown
Contributor

@ricky122-5 please fix the pre-commit issues and then let us know if it's ready to be merged

@ricky122-5
ricky122-5 force-pushed the ricky122-5/update-docs-build-md branch from d4c8934 to f9f8f6c Compare May 20, 2026 20:17
@ricky122-5
ricky122-5 force-pushed the ricky122-5/update-docs-build-md branch from f9f8f6c to 50b0ef4 Compare May 20, 2026 20:45
@bthomee
bthomee added this pull request to the merge queue May 21, 2026
Merged via the queue into XRPLF:develop with commit afcf6fb May 21, 2026
1 check passed
@ricky122-5
ricky122-5 deleted the ricky122-5/update-docs-build-md branch May 21, 2026 13:15
@bthomee bthomee added this to the 3.2.0 milestone May 27, 2026
Kassaking7 pushed a commit to Kassaking7/rippled that referenced this pull request Jun 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Trivial Simple change with minimal effect, or already tested. Only needs one approval.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants