summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2024-03-05Update documentation, now that "foreign file" roots are implementedKlaus Aehlig
2024-02-27symlinks design doc: Fix typoPaul Cristian Sarbu
2024-02-26Add a design document for foreign-file rootsKlaus Aehlig
2024-02-15git-gc design: fix typosKlaus Aehlig
2024-01-30Drop multi-rc from future designs, as it is implementedKlaus Aehlig
2024-01-26doc: Extend 'just serve' design with absent roots sync changesPaul Cristian Sarbu
Adds documentation for the new proto requests required for the 'to_git' pragma root handling, as well as general syncing of root trees. Also adds clarifying comments on handling of absent roots by just-mr.
2024-01-23Add design for using multiple mrrc filesKlaus Aehlig
2024-01-18Document the implementation of tc deps tracking on gcKlaus Aehlig
2024-01-16Design interaction between target-level caching and garbage collectionKlaus Aehlig
The implicit extensional projection of target-level caching and garbage collection interact in a subtile way. Add a design document describing how we keep the invariant required by target-level caching in the presence of garbage collection. While, techincally, this just describes how to fix a bug, a careful design is still needed, as some fundamental changes are made.
2024-01-09large-blob design: fix file nameKlaus Aehlig
2024-01-08doc: Extend just serve design with 'tree of a distdir' auxiliary requestPaul 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-12-18future-designs: Add proposal for 'just add-to-cas' subcommandPaul Cristian Sarbu
2023-12-18Add design document for adding garbage collection for build rootsKlaus Aehlig
2023-12-15just serve design doc: Update and move to conceptsPaul Cristian Sarbu
2023-12-12Add design on more compact storing of large filesKlaus Aehlig
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.