Skip to content

Added info on jobs argument for ./b target #355

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.

Sign up for GitHub

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

Open
ZeoNyph wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added info on jobs argument for ./b target #355

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/book/02-system/01-foundations/02-build-system.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ Any changes you make outside of the `/home/nubots/NUbots` or `/home/nubots/build

##### Target

The `target` command of `b` allows you to build code for a different target. Support targets are
The `target` command of `b` allows you to build code for a different target. Supported targets are

- `generic`: Useful if you would like to build and run code on your local machine.
- `nuc7i7bnh`: For use with the old nuc7i7bnh computer. This is no longer used on the robots.
Expand All @@ -369,6 +369,14 @@ The `target` command of `b` allows you to build code for a different target. Sup

The `target` command will download (or, if needed, build) the Docker image for the specified target and then mark that target as active.

<Alert type="info">

If you do need to build the image from scratch, and you find you are running out of memory during the build process, you can set the maximum number of jobs the builder can run by adding the `-j` argument.

For example, `./b target nuc12wshi7 -j8` will only run a maximum of eight jobs.

</Alert>

##### Tests

The `tests` command allows you to run built unit tests. It will automatically run tests in parallel, and dump a timestamped log file to the project directory. Currently, we use [CTest](https://cmake.org/cmake/help/latest/manual/ctest.1.html) which is included as part of CMake.
Expand Down