summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
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
2022-07-12rules documentation: mention use cases for providersKlaus Aehlig
While there, fix a few typos in the same document as well.
2022-06-28Generic: add support for out_dirsAlberto Sartori
Before this patch, the built-in "generic" type allowed for just output files, listed in the field "outs". Now, the type also supports output directories, listed in the "out_dirs" field. The output directories are created before the command is executed.
2022-06-24Tutorial: Add section about testsOliver Reiche
2022-06-22Tutorial: Updated proto sectionOliver Reiche
2022-06-20Document the concept of target-level cachingKlaus Aehlig
2022-06-20Disallow comparison of namesKlaus Aehlig
In our semantics, it was always intended that names are completely opaque and only used by passing them to functions providing information about a target. However, we never enforced that they not be compared for equality, even though we always had this in mind, and the computation of the target-level cache key was designed with this semantics in mind. Enforce this restriction now.
2022-06-20Tutorial: Regenerate screenshots with adjusted hashesOliver Reiche
2022-06-17Add tutorial on how to use proto buffers with justKlaus Aehlig
While we assume the reader already knows what proto buffers are, the tutorial introduces the concept of anonymous targets.
2022-06-14Tutorial: Add section about 3rd party softwareOliver Reiche
2022-06-13Tutorial: Update hello world tutorial screenshotsOliver Reiche
2022-06-09fix typosAlberto Sartori
2022-06-02Tutorial: Simplify hello world sectionOliver Reiche
... to initially use rules' predefined defaults.
2022-06-01user-defined rules: describe the TREE functionKlaus Aehlig
In the defining expression of a rule, the TREE function is also available. Document this.
2022-05-31"enumerate" expression: add padding to 10 charactersKlaus Aehlig
2022-05-30Built-in expressions: add enumerateKlaus Aehlig
Add a function transforming a list into a map. In this way, artifacts collected positionally in a list can easily be realized as a stage used for input to an action or output of a target.
2022-05-24Tutorial: Add hello world sectionOliver Reiche
2022-05-24concepts: describe configurationKlaus Aehlig
2022-05-20overview over the most important concepts of the toolKlaus Aehlig
2022-05-10Document built-in rulesKlaus Aehlig
2022-05-09Built-in "to_subdir": interpret input keys as pathKlaus Aehlig
... and detect conflicts araising this way. Also normalize the paths after staging them to the specified subdir.
2022-05-09Verify conflict-freeness in inputs, artifacts, and runfilesKlaus Aehlig
Our maps serve two purposes: on the one hand, they can be a generic key-value association with arbitrary strings as keys. On the other hand, we use them to describe arrangements of files (inputs to actions, artifacts or runfiles generated). In this function, certain keys refer to the same path and hence have to be identifed. Therefore, at places where the keys clearly have to be paths in the file system, implicitly normalize them and check for conflicts.
2022-05-09doc/concepts/anonumous-targets.org: fix markupKlaus Aehlig
While there, also fix a few typos.
2022-04-26doc strings: support documentation of the resultKlaus Aehlig
A complete documentation of a rule should not only include how to use it (i.e., which fields are present and what is their meaning) but also what the result is. This is particularly true, as the result is structured and can contain some complex logic or conventions in the provided information.
2022-04-25expression: add "msg" argument to "to_subdir"Klaus Aehlig
... allowing to provide additional information in case of conflict during flat staging.
2022-04-21Document the expression language used in our build toolKlaus Aehlig
2022-04-07Add basic documentation on build rulesKlaus Aehlig
2022-03-24Document our cache-pragmas for actionsKlaus Aehlig
... that allow us to treat builds and tests in a uniform way, basically by building a test report.
2022-03-24doc/concepts/anonymous-targets.org: fix org markup typoKlaus Aehlig
2022-03-22Add basic documentation for anonymous targetsKlaus Aehlig
2022-03-22Add documentation for the basic concepts of multi-repo buildsKlaus Aehlig
2022-03-22Document the way we use our documentation stringsKlaus Aehlig