summaryrefslogtreecommitdiff
path: root/doc/source/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* using_commands.rst: Split out the artifact subcommandsJames Ennis2019-01-221-1/+1
|
* Fix spelling of it's and itsRichard Dale2018-10-163-6/+6
|
* Documentation typos and fixesWilliam Salmon2018-07-261-1/+1
| | | | | | Daniel went through the Doc's etc and made a list of suggestions. These are the result of the most easily patched suggestions and one or two thing that I noticed as well.
* doc: Adding part 4 of the getting started tutorial: integration commandsTristan Van Berkom2018-06-251-0/+130
| | | | | This new section talks about how integration commands work and shows them at work.
* doc/source/tutorial/running-commands.rst: Added tip about using `--` in `bst ↵Tristan Van Berkom2018-06-251-0/+10
| | | | shell`
* doc/source/tutorial/autotools.rst: Consistent wording of "chapter"Tristan Van Berkom2018-06-251-1/+1
| | | | | We've been calling these tutorials "chapters", let's not start also calling them "sections".
* doc: Use consistent titles when referring to files in an example projectTristan Van Berkom2018-06-181-0/+8
| | | | | | | | | | | | Use the following form across the board: ``elements/foo.bst`` ~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: ../path/to/foo.bst :language: yaml Always use an example project relative path, too.
* doc: Adding part 3 of the getting started tutorial: autotools elementTristan Van Berkom2018-06-181-0/+146
| | | | | | | | | This part of the tutorial uses a lot of the work from Phil Dawson and James Ennis, and uses their example submitted on merge request 499 as a basis to introduce the user to yaml composition and variable resolution. This is a part of issue #103
* doc/source/tutorial/running-commands.rst: Adding summaryTristan Van Berkom2018-06-181-1/+22
| | | | And adding some link anchors needed by the incomming chapter.
* doc: Adding part 2 of the getting started tutorialTristan Van Berkom2018-06-171-0/+205
| | | | | | | | | | | | | o doc/examples/running-commands: New example project of a `manual` build element o doc/sessions/running-commands.run: New session file to capture bst output o doc/source/sessions-stored: Added new generated sessions o doc/source/tutorial/running-commands.rst: New tutorial entry describing how commands are run in the sandbox o tests/examples/running-commands.py: Test case validating the tutorial's assertions
* doc/source/tutorial/first-project.rst: Adding linksTristan Van Berkom2018-06-171-3/+6
| | | | | Linking out to the relevant invoking pages for the command line reference, and adding a link anchor here for use by the next chapter.
* doc: Adding part 1 of the getting started tutorialTristan Van Berkom2018-06-161-0/+117
o doc/Makefile: Added new directory to collect rst files from o doc/examples/first-project: Added the "first-project" example project. o doc/source/sessions/first-project-*.html: Added the generated snippets o doc/source/using_tutorial.rst: Added the new main tutorial page o doc/source/tutorial/first-project.rst: Added part 1 of the tutorial here o tests/examples/first-project.py: Added test for the example project This is largely based on an example by Javier Jardón, which was submitted at https://gitlab.com/BuildStream/buildstream/merge_requests/323 Fixes #103
View Lorry Controller Status