summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2024-10-23Update rules reference in tutorialKlaus Aehlig
2024-10-09doc: fix a typoAlberto Sartori
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-08-14expression language: add nub_leftKlaus Aehlig
Originally, the expression lanuage only contained a function to deduplicate a list, keeping only the right-most occurence. The reason was that this is the order needed for linking: a library providing an open symbol has to come on the command line after the library using that symbol (and hence making it an open symbol). However, by now use cases have emerged that require a topological sorting where definition comes before use; also, when composing the value of PATH from fragments, we usually want to keep the first occurrence in order for it to take precedence. Therefore, also add "nub_left" as built-in function, allowing a more condense (and slightly more efficient) description in rules instead of the revserse-nub_right-reverse pattern.
2024-08-05Expression language: add expression from_subdirKlaus Aehlig
... allowing to select only the keys in a specific subdir, and move the them to top-level.
2024-08-02CHANGELOG: mention cwd supportKlaus Aehlig
... and drop the corresponding design document as implemented.
2024-08-02generic rule: add support for cwdKlaus Aehlig
2024-08-02rules: make ACTION expression support "cwd"Klaus Aehlig
2024-07-30Add design document on supporting a working directory inside the action ↵Klaus Aehlig
directory ... instead of always having to execute actions in the top-level directory.
2024-07-26Add quasiquote expressionKlaus Aehlig
2024-07-26expression language: add quotingKlaus Aehlig
2024-07-24Remove implemented design document on root gcKlaus Aehlig
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-07-08Remove hardlink design as implementedKlaus Aehlig
... and mention the fix in CHANGELOG.
2024-07-03Add a design document on how to handle the hard-link limitKlaus Aehlig
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-06-25describe: also describe "configure" targets in more detailKlaus Aehlig
Most built-in rules are just described by their name, assuming they are known to the user anyway. One exception, however, are "export" targets, as those serve as interfaces to (logical) repositories and hence is supposed to have a documentation of the target itself. Over time, however, "configure" targets have evolved to become internal interfaces (maybe even for an external target), e.g., to provide default values and hence make better use of the actual export target. Therefore it is desirable to provide a bit more information when asked to describe a "configure" target. - As "configure" targets have a fixed set of keys, adding a "doc" field is a conservative extension; this can be useful to give an overview what the target is about. - An important information of a "configure" target is the target that is configured. While this, in general, is an expression, in the typical cases, the description is very short (a literal target name, or a variable). So we can afford to show the definition.
2024-06-25documentation: fix typoKlaus Aehlig
2024-06-12Tree-overlay design: support disjoint overlayKlaus Aehlig
2024-06-06Update documentation about tc writing in the presence of serveKlaus Aehlig
2024-06-05Add design on how to extend our handling of symbolic linksKlaus Aehlig
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-05-13doc rules: Fix typoPaul Cristian Sarbu
2024-05-03Remove large-blobs from future designs as it is implementedKlaus Aehlig
... and document the implementation in the concepts documentation.
2024-04-29expressions doc: Fix typosPaul Cristian Sarbu
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-24expressions: add logical negationKlaus Aehlig
While this can already be expressed by an "if" statement, having a dedicated function for logical negation makes some expressions more readable.
2024-04-24expressions: for "if" expressions, make both branches optionalKlaus Aehlig
... using, also for the "then" branch, the empty list as default. In this way, this statement not only more symmetric, but also allows shorter representations of some typical expressions.
2024-04-24expressions: add "length" functionKlaus Aehlig
Lists are somtimes used in configurations as replacement for tuples. Providing length gives an easy way to detect usage errors.
2024-04-24expressions: add generic assertionsKlaus Aehlig
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-16expression language: add array access by indexKlaus Aehlig
2024-04-15just-execute doc: Small improvementsPaul Cristian Sarbu
2024-04-15tutorial: Consistent formatting and small fixesPaul Cristian Sarbu
2024-04-12service-target-cache doc: Remove obsolete conceptPaul Cristian Sarbu
2024-04-08doc: Remove logo frame for better visibilityOliver Reiche
... and set quadratic bounding box.
2024-04-08doc: Add Justbuild logoOliver Reiche
2024-03-28CAS-import design: update implementation stateKlaus Aehlig
2024-03-26Expression language: add float operations "*" and "+"Klaus Aehlig
Numerical values are used at some places in justbuild: as value for timeout scaling, as well as by the "range" expression that is used, e.g., to define repreated test runs. Therefore, improve support for numerical values by adding basic operations.
2024-03-20add-to-cas proposal: update design to reflect state of implementationKlaus Aehlig
The base functionality is already implemented. Also, the default has changed with respect to the design to make reading symlinks the default and only follow symlinks if the optin --follow-symlinks is given.
2024-03-11gc: add option --no-rotationKlaus Aehlig
... to clean up what can be done without losing cache information.
2024-03-08doc: Improve description of "preferred hostnames"Oliver Reiche
2024-03-05Update documentation, now that "foreign file" roots are implementedKlaus Aehlig