summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-12-11Documentation for "configure" rule: clarify role of "config"Klaus Aehlig
... as an overlay for the configuration, not the configuration to be used for the target to configure.
2023-11-29Add design document on tree-overlay actionsKlaus Aehlig
2023-11-23Move blob-splitting design document to implemented conceptsSascha Roloff
2023-11-22Update blob splitting design documentSascha Roloff
2023-11-15amend service-target-cache.mdAlberto Sartori
Remove wrong (un-needed) design specifications. When we compute the TargetCacheKey of an export target, there is no need to check if any of (recursively) referenced trees is absent. As soon as we deal with an "absent target" we query just serve. If it is not able to provide the target cache value, we error out.
2023-11-15target-cache.md: fix a typoAlberto Sartori
2023-11-14alternative-mirrors design doc: Move to concepts folderPaul Cristian Sarbu
...and reword content to move from proposal to implemented state.
2023-11-14alternative-mirrors design doc: Update local specification key namesPaul Cristian Sarbu
This improves clarity while maintaining specificity of the JSON file entries. Also fixes the typo in the design document name.
2023-11-13Add end-to-end test for environment handling of "git tree" repositoriesKlaus T. Aehlig
... ensuring that just-mr passes on the specified environment variables (and only those) to the tree-generating action.
2023-10-27extended-git-tree-variables doc: fix typoPaul Cristian Sarbu
2023-10-27Add design about having additional variables available in git-tree actionsKlaus Aehlig
2023-10-25just serve: document the changes required in the analysis of an export targetAlberto Sartori
Co-authored-by: Paul Cristian Sarbu <paul.cristian.sarbu@huawei.com>
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-10-23Add a design for supporting additional mirrors in just-mrKlaus Aehlig
2023-09-13target-level caching as a service design: add clarifying commentsKlaus Aehlig
- Document that `just serve` can be asked to back up a tree to the remote execution end point. - Specify, that similar to getting the tree of a commit, just serve can also be asked to provide the tree of an unpacked archive given by its blob identifier. - Document the auxilliary request by which `just build` can get the needed information about the flexible variables of an export target in order to construct the correct cache key.
2023-08-28Extend built-in "generic" rule to allow setting "sh"Klaus Aehlig
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-08-14expression: add new built in "reverse"Klaus Aehlig
While a foldl is enough to implement a reverse functionality, adding it as a built in allows doing so in linear time.
2023-08-14expression: add new built in "set"Klaus Aehlig
... to obtain from a list of strings a map with those entries as keys and true as value. In this way, repeated membership tests in lists can be implemented more efficiently.
2023-08-10doc: Extend documentation with 'symlink' built-in rulePaul Cristian Sarbu
2023-08-07doc: Extended treatment of symlinks in roots and treesPaul Cristian Sarbu
We now allow restrictive use of upwards symbolic links when importing filesystem directories and archives to git.
2023-07-19Add a tutorial on cross compilingKlaus Aehlig
2023-07-12Execution properties are no longer a future designKlaus Aehlig
... but an implemented concept. Update the documentation accordingly.
2023-06-28doc: Move non-upwards symlinks to conceptsPaul Cristian Sarbu
Also link it in the README.
2023-06-28doc: Fix description of built-in rule genericOliver Reiche
2023-06-26Add non-upwards symlinks in the rule language...Paul Cristian Sarbu
via a 'SYMLINK' constructor function. This works similarly to the 'FILE' construct, but the name given must point to a non-upwards symlink and a symlink artifact is being generated from it. Also updates the relevant tests.
2023-06-22Extend execution-properties design: the generic rule is extended the same wayKlaus Aehlig
2023-06-22Execution-properties design: allow null valuesKlaus Aehlig
... as the result of evaluating "timeout scaling" or "execution properties". This implicit default is already implemented and allow simple access to variables without having to care for default values, thus having simpler rules.
2023-06-15Add design document about blob splittingSascha Roloff
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-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