summaryrefslogtreecommitdiff
path: root/doc/tutorial
AgeCommit message (Collapse)Author
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
2023-08-22tutorial: Use new TOOLCHAIN_CONFIG variableOliver Reiche
2023-08-18tutorial, third party: also mention pkg-config as optionKlaus Aehlig
While there, - remove the outdated claim that in package build of just the prebuilt library aproach of a header-only library with link dependencies is chosen, and - remove a wrong footnote separator.
2023-08-18documentation: third-party code may also be built using foreign toolsKlaus Aehlig
... while providing a native descirption still is the cleaner approach. Nevertheless, hinting on this fact early avoids scaring off novice users having a lot of dependencies.
2023-08-17tutorial: mention the describe subcommandKlaus Aehlig
... as a way to find out more about the defining rule of a target. While there, also be a bit more explicit about target naming and the fact that the default target is a target of the rules repository.
2023-08-17documentation: add some clarifying commentsKlaus Aehlig
... emphasizing that source files are just targets and that we could as well use a defined target there.
2023-08-16tutorial: Add missing language specifierOliver Reiche
2023-08-14doc: Fix typos in tutorialPaul Cristian Sarbu
2023-07-19Add a tutorial on cross compilingKlaus Aehlig
2023-06-12just execute tutorial: hint on the --compatible optionKlaus Aehlig
... so that users who want use just as an execution service for other build tools are aware and don't run into errors due to incompatible hashes.
2023-06-12doc: Minor format and consistency improvementsOliver Reiche
2023-06-12doc: Convert orgmode files to markdownOliver Reiche
2023-05-08tutorial/proto: Also show how to build just the CC bindingsKlaus Aehlig
2023-04-26Tutorial: take latest commit of rules-ccKlaus Aehlig
2023-04-26Test tutorial: defaults from shell/test need to be declaredKlaus Aehlig
... also for CC tests, as this contains the shared tools, e.g., for flakyness handling.
2023-04-18Fix typos "boostrap" -> "bootstrap".Niklas Hambüchen
I know "boost rap" is a popular music genre among C++ programmers today, but nevertheless this is a typo.
2023-03-29wip:just execute tutorialAlberto Sartori
2023-02-28Various typo fixesPaul Cristian Sarbu
Co-authored-by: Sascha Roloff <sascha.roloff@huawei.com>
2022-12-16tutorial: Add missing hello.cpp to rebuild sectionOliver Reiche
2022-12-16tutorial: Update file-glob-tree sectionOliver Reiche
... by using the fully declared rules-cc repository and feeding ed from stdin.
2022-12-16tutorial: Update proto sectionOliver Reiche
... by explicitly specifying the protobuf repository and using just-import-git to import the rules-cc repository. Furthermore, protobuf's subdir "examples" is used directly and all targets are created in the top-level module.
2022-12-16tutorial: Update tests sectionOliver Reiche
... by adding some remarks and creating all tests in module "tests".
2022-12-16tutorial: Use rules-cc from public Git repositoryOliver Reiche
2022-12-16tutorial: Fix typosOliver Reiche
2022-12-16tutorial: Fix use of new rule interfaceOliver Reiche
2022-12-12tutorial/proto.org: update target and regenerate screen shotsKlaus Aehlig
... given that binaries now only have "private-proto" (as there are no public dependencies of a binary anyway). While there, also hint on the script for git imports, to simplify the setup of the example.
2022-12-09tutorial: add some clarifying commentsKlaus Aehlig
... on parts a first-time reader might (and actually did) stumble upon.