summaryrefslogtreecommitdiff
path: root/doc/sessions
Commit message (Collapse)AuthorAgeFilesLines
* Added doc's for workspace reset --softpointswaves/softresetWilliam Salmon2019-03-211-0/+5
|
* cachedir: add new dir option that's default root to other dirsRaoul Hidalgo Charman2019-02-191-1/+1
| | | | | | Makes artifactdir and builddir obsolete. Fixes #870
* doc: Point out that element is optional when commands are run from the workspacejonathan/workspace-fragment-guess-elementJonathan Maw2018-12-111-0/+5
| | | | This is a part of #222
* Workspace CLI updateWilliam Salmon2018-11-212-3/+3
| | | | | | | This is to update the workspace CLI to as agreed on the mailing list https://mail.gnome.org/archives/buildstream-list/2018-September/msg00046.html This patch also introduces the default workspace directory.
* doc/sessions/developing.run: Fix the session to actually run `patch` as a ↵Tristan Van Berkom2018-08-051-1/+2
| | | | | | | | shell command Since we added support for shell commands in bst2html, this can now be fixed. This is a part of issue #553
* doc/sessions: Add terminal sessions for use in workspaces tutorialPhil Dawson2018-08-011-0/+49
| | | | This is part of the the work towards issue #437
* junctions.run: Add terminal session output for junctions walkthrough.Phil Dawson2018-07-301-0/+20
| | | | This is part of the work towards #437.
* doc: Adding part 4 of the getting started tutorial: integration commandsTristan Van Berkom2018-06-251-0/+15
| | | | | This new section talks about how integration commands work and shows them at work.
* doc: Adding part 3 of the getting started tutorial: autotools elementTristan Van Berkom2018-06-181-0/+20
| | | | | | | | | 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: Adding part 2 of the getting started tutorialTristan Van Berkom2018-06-171-0/+25
| | | | | | | | | | | | | 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: Adding part 1 of the getting started tutorialTristan Van Berkom2018-06-161-0/+37
| | | | | | | | | | | | | | | | | | | | | 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
* doc: Improve the new console output html generatorTristan Van Berkom2018-06-133-18/+21
| | | | | | | | | | Before we were creating one description file for each output, making it easier to declare a make rule for it - but the result was that we would have to build things more and it takes a long time. Instead, now we have session files which describe a series of commands to run in a session, and each command optionally produces an output file.
* doc: Don't allow setting a height on the generated session htmlTristan Van Berkom2018-06-121-3/+0
| | | | | | This was a bad idea and doesnt play well with mobile UIs, better off to just include the whole thing even if it's long, and let the backing page handle vertical scrolling.
* doc/sessions: Added run files describing scenarios to buildTristan Van Berkom2018-06-122-0/+21
The Makefile uses these to run some scenarios which are later included by the documentation directly.