summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
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-03-07Add a design document on action-controlled execution propertiesKlaus Aehlig
2023-02-28Various typo fixesPaul Cristian Sarbu
Co-authored-by: Sascha Roloff <sascha.roloff@huawei.com>
2023-02-24Add design document on computed rootsKlaus Aehlig
2023-02-22docs: Fix typos in general documentationPaul Cristian Sarbu
2023-02-20Add a design describing target-level caching as a serviceKlaus Aehlig
2023-02-14Package bootstrapping: support copying the needed partsKlaus Aehlig
... while following symbolic links. In this way, bootstrapping is possible against preinstalled dependencies that symbolic links or special files in their directories.
2023-02-10Add a design on handling of symbolic linksKlaus Aehlig
... describing the background as well as proposing a possible way to treat symbolic links in our build system.
2023-02-10Start a directory for design documentsKlaus Aehlig
2023-01-20Document the conepts behind garbage collectionKlaus Aehlig
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-12-07Built-in rules: add a tree ruleKlaus Aehlig
... so that for every construct supported in rules there is an analogous one as a built-in rule to allow ad-hoc constructions without having to write a rule (even though writing a rule is recommended for everything occuring more than once): - the "generic" rule allows an ad-hoc ACTION, - the "file_gen" rule allows an ad-hoc BLOB, - the "tree" rule allows an an ad-hoc TREE, and - the "configure" rule allows an ad-hoc configuration transition.
2022-11-23Document the configuration transition in configureKlaus Aehlig
The built-in rule configure carries out a full configuration transition. While this is useful in quite a few situations, care has to be taken to avoid conflicts on dependencies also used in other ways by the calling target. Document this more clearly in the documentation.
2022-11-17fix a typoAlberto Sartori
2022-11-16Make "config" accept a computed targetKlaus Aehlig
... and thus allowing the "business logic" in the configuration target (e.g., setting defaults and derived options) to be shared by many targets.
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-04fix a typoAlberto Sartori
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-10-05Doc: Describe usage of 'configure' built-inOliver Reiche
2022-10-05Doc: Describe usage of 'env' expressionOliver Reiche
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).
2022-08-24Glob tutorial: fix typos and white spaceKlaus Aehlig
2022-08-23Add a tutorial section explaining targets vs explicit source referencesKlaus Aehlig
2022-08-22Tutorial: Add minimalistic getting started sectionOliver Reiche
2022-08-19Tutorial: Use sh instead shell for improved renderingOliver Reiche
2022-08-19Add glob reference to source filesKlaus Aehlig
Like file or tree references, globs are restricted to the current module; in fact, by the way we evaluate them, even to the top-level directory of that module: a glob is a target having as artifacts and runfiles those entries of the top-level directory of the specified module that match the given pattern.
2022-08-05Added remote execution specification documentSascha Roloff
Co-authored-by: Alberto Sartori <alberto.sartori@huawei.com>
2022-07-28Upd tutorial to reflect new just-mr setup outputPaul Cristian Sarbu