summaryrefslogtreecommitdiff
path: root/doc/tutorial
AgeCommit message (Collapse)Author
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.
2022-12-09rules: Refactoring and minor improvementsOliver Reiche
Compared to the previous commit, the action graphs for just and its unit tests are unchanged. - Git hash of action graph for ["",""]: c6e75f17abd7ffaab6ff9bb725ad67ec0bf6c973 - Git hash of action graph for ["test/buildtool","TESTS"]: 8063dfb3dd7daa9ae01d95c177e14946f785c57e Refactor: - "local cflags" to "private-cflags" - "local defines" to "private-defines" - "link externals" to "private-ldflags" - "deps" to "private-deps" for (test) binaries - "proto" to "private-proto" for binaries Improvements: - consistent variable declaration order: OS, ARCH, HOST_ARCH, TARGET_ARCH, CC, CXX, CFLAGS, CXXFLAGS, ADD_CFLAGS, ADD_CXXFLAGS, AR, ENV, PATH - use fields close to their definition (in RULES) - use common expression for binaries and test binaries - split expression "flags" and "compiler" ... to separate ones for CC and CXX. - rename "transition" to "deps-transition" ... to avoid conflicts with other transitions. - support "defaults-transition" for CC expressions Implement: - "cflags" for libraries - "private-cflags" for (test) binaries - "private-defines" for test binaries - "private-ldflags" for test binaries - (public) "defines" for libraries
2022-12-09rules: Drop the ["CC", "header directory"]Oliver Reiche
... in favor of the "tree" built-in rule.
2022-12-08tutorial: Use newly introduced private-deps for fmtOliver Reiche
2022-11-17fix a typoAlberto Sartori
2022-11-14tutorial: hint on --dump-varsKlaus Aehlig
... when introducing export targets. In this way, the user has a way to take a meaningful decission on which variables to export.
2022-11-07tutorial: describe using pre-built dependenciesKlaus Aehlig
While building from source as certain advantages, there are also good reasons to use pre-installed dependencies. Document this in the tutorial to avoid wrong impressions readers might have otherwise.
2022-11-02tutorial/getting-started: Also introduce the concept of stagingKlaus Aehlig
Staging is quite a fundamental concept of just. Therefore, introduce it early in the tutorial. In this way, it also becomes obvious, why only targets are requested and files are not installed by default.
2022-11-02Tutorial getting-started: introduce -PKlaus Aehlig
... as an way of directly obtaining an artifact without an additional detour through the file system.
2022-11-02tutorial/getting-started: better explain object identifiersChristian Lütke Stetzkamp
When the tutorial references blob identifiers in the output, also immediately explain the syntax. Also emphasize the possible abbreviations made possible by b9880e8ecdce02f047dfb1d19de5f1ed07a82ac6 given that they are typically used in practise. Co-authored-by: Klaus Aehlig <aehlig@linta.de>
2022-10-20Tutorial: Adjust 'test/glob/rebuild/proto' sectionsOliver Reiche
2022-10-20Tutorial: Adjust 'Third-party' section to new changesOliver Reiche
2022-10-20Tutorial: Adjust 'Hello world' section to new changesOliver Reiche
2022-10-07Tutorial: add section on `just rebuild`Klaus Aehlig
2022-08-26tutorial/test: demonstrate that the internals of the test are availableKlaus Aehlig
... by explaining how to install the test binary and manually interact with it. This also shows how to inspect an action for debugging.
2022-08-26tutorial/thrid-party-software: clarify tree refrenceKlaus Aehlig
... emphasizing that it constructs only a single artifact. In this way, we avoid confusion with globs (that are introduced later).