summaryrefslogtreecommitdiff
path: root/doc/tutorial
AgeCommit message (Collapse)Author
5 daysdoc: Fix various typos and inconsistenciesPaul Cristian Sarbu
9 daysTutorial: also point to the computed root used in the justbuild repoKlaus Aehlig
9 daysDocumentation: fix some typosKlaus Aehlig
2025-06-13Extend invocation-logging tutorialKlaus Aehlig
Environment variables can be used to provide some context, why a particular invocation was run, and hence allow additional sharding. Also, remind that setting up a cronjob for log rotation might me a good idea.
2025-06-05lint tutorial: hint on the discovered but not processed actionsKlaus Aehlig
Linting is a natural example where actions are discovered that are not neded for the artifact that is requested to be built. Use this opportunity to explain the difference between discovering an action and processing it.
2025-06-05tutorial lint: Update example outputPaul Cristian Sarbu
2025-05-23tutorial: Update example outputs in all chaptersPaul Cristian Sarbu
...to match the ones produces by latest binaries and rules.
2025-05-23tutorial computed: Fix source of non-reproducibility in example scriptPaul Cristian Sarbu
While there, update outputs to what is expected with current released binaries and rules. Co-authored-by: Klaus Aehlig <klaus.aehlig@huawei.com>
2025-05-23tutorial: Add DWP and ADD_DEBUGFLAGSPaul Cristian Sarbu
...to example export targets and defaults.
2025-05-23tutorial debugging: Use ADD_COMPILE_FLAGSPaul Cristian Sarbu
...instead of replacing CFLAGS and CXXFLAGS, thus also fixing a mismatch introduced in c008c07656fff528c80add260397c7c7702aa2a8.
2025-05-23Extend tutorial on cross compiling showing how to use ["test", "matrix"]Klaus Aehlig
2025-05-15just-mr: support invocation-specific artifacts-to-build loggingKlaus Aehlig
It is already supported to ask just-mr (via the rc file) to log for each invocation the artifacts that were built. Add a similar option for the artifacts that were to be built, i.e., for dumping the intensional description of the output artifacts. That information can be used, e.g., to compute the critical path.
2025-05-15tutorial invocation logging: include --dump-artifactsKlaus Aehlig
A typical invocation logging would also include a value for "--dump-artifacts". Mention this in the tutorial.
2025-05-14tutorial, test: recommend ["test", "suite"] for combining testsKlaus Aehlig
... as this also works together with, e.g., linting. While there, also rerun the examples to get the latest output messages.
2025-05-13Tutorial: Update reference to rules-ccOliver Reiche
2025-05-09Add basic introduction to tree overlaysKlaus Aehlig
2025-04-23Tutorial: mention the possibility to browse individual invocationsKlaus Aehlig
2025-04-23tutorial: Update DEBUG config variable to mapPaul Cristian Sarbu
In preparation for the rule changes, to avoid introducing false positives during future bisections.
2025-04-16Add basic tutorial section on invocation loggingKlaus Aehlig
... under the advanced chapter of our tutorial.
2025-04-14clean up markdown in tutorial and conceptsKlaus Aehlig
... and ensure that pandoc processes them correctly. In particular, add an empty line around itemize environments.
2025-03-17Extend tutorial to also include other uses of build delegationKlaus Aehlig
2025-03-06tutorial: Add chapter on just-lockPaul Cristian Sarbu
Also update the README.
2025-03-06tutorial: Consistently use the fmtlib release tagPaul Cristian Sarbu
...instead of using the master branch.
2025-02-18tutorial: update tests sectionKlaus Aehlig
Add the artifacts and outputs of the updated rules, as well as some explanatory remarks.
2025-02-18tutorial: update rebuild sectionKlaus Aehlig
- As we build a binary hello, make it an extension of the hello we had before. - Make the passing of time more explicit. - Add actual output of rerunning the tutorial.
2025-02-17tutorial: update hello-world sectionKlaus Aehlig
As our defaults rule supports flags common for C and C++ use them, especially as our example only uses common flags.
2025-02-17tutorial: update reference to rules-ccKlaus Aehlig
2025-02-14tutorial, getting started: add the basics of analyseKlaus Aehlig
2025-02-14tutorial, getting started: include more idiomatic use of optionsKlaus Aehlig
... in particular in the case of targets producing precisely one artifact; this better emphasizes the idea that we talk to the tool in terms of targets. While there, also add some clarifying comments.
2025-01-30Add basic introduction on how to set up computed rootsKlaus Aehlig
2024-10-23Update rules reference in tutorialKlaus Aehlig
2024-09-11Add a tutorial on setting up lintersKlaus Aehlig
2024-09-11Update rules-cc commit in tutorialKlaus Aehlig
2024-08-27debugging tutorial: Update to include correct toolchain defaultsPaul Cristian Sarbu
This is an essential step in the debugging process that was missing in the tutorial.
2024-07-08tutorial on tests: set shell defaultsKlaus Aehlig
... as they will be used in newer versions of rules-cc to set the path for the test-summary action.
2024-06-26proto tutorial: Add section on debuggingPaul Cristian Sarbu
This showcases that also generated proto headers will be staged for debugging.
2024-06-26Add tutorial to showcase debuggingPaul Cristian Sarbu
2024-06-263rd-party tutorial: Add DEBUG flag for fmtlib export targetPaul Cristian Sarbu
This is good practice and it makes it easier to later demonstrate debugging, as the flag value is honored. Also renames the final repos.json example, in order to ensure that any chapters depending on the output of this chapter receives the correct repository description.
2024-06-26tutorials: Fix small typosPaul Cristian Sarbu
2024-06-26tutorials: Update rules-cc commitPaul Cristian Sarbu
...to version fully supporting debugging.
2024-05-15Test tuorial: mention creating a defaults definition for the shell toolchainKlaus Aehlig
... so that the tutorial also works with the latest version of our rules.
2024-04-25just serve: Paths in config file should be location objectsPaul Cristian Sarbu
Also updates the tests and all relevant documentation accordingly.
2024-04-24Add first version of just-serve tutorialPaul Cristian Sarbu
2024-04-23tutorial: Update outputs and other improvementsPaul Cristian Sarbu
When tutorial docs were changed to showcase running commands with just-mr instead of just, the outputs were not changed. This is now fixed to showcase the results run with current master just-mr (and just), together with other small improvements and fixes.
2024-04-15just-execute doc: Small improvementsPaul Cristian Sarbu
2024-04-15tutorial: Consistent formatting and small fixesPaul Cristian Sarbu
2023-12-19tutorial: explain the difference between action graph and the traversed partKlaus Aehlig
When explaining CC tests, the option --request-action-input is used to get hold of the actual test binary. This is the first time in the tutorial where the action graph is larger than the part that that is traversed during the build. Use this oportunity to explain the difference between those concpets as, reportedly, some users got confused about this.
2023-10-24just-execute tutorial: recommend statically linked binaresKlaus Aehlig
... and point to the repository with machine-readable instructions on how to properly build them.
2023-08-25tutorial: hint on `just describe` to list implicit dependenciesKlaus Aehlig
2023-08-22Update tutorial to use latest version of rules-ccKlaus Aehlig