summaryrefslogtreecommitdiff
path: root/doc/tutorial
AgeCommit message (Collapse)Author
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-11-17fix a typoAlberto Sartori
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-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-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-07-28Upd tutorial to reflect new just-mr setup outputPaul Cristian Sarbu
2022-06-24Tutorial: Add section about testsOliver Reiche
2022-06-22Tutorial: Updated proto sectionOliver Reiche
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-02Tutorial: Simplify hello world sectionOliver Reiche
... to initially use rules' predefined defaults.
2022-05-24Tutorial: Add hello world sectionOliver Reiche