summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* install_linux_distro.rst docs: updated to point user to latest stable branchpatch-1Laurence Urhegyi2018-08-151-2/+9
| | | | | adds a description of the semantic versioning convention that BuildStream uses adds a sentence telling users to follow this convention and navigate to the latest tag
* docs: Add documentation for Configurable WarningsJosh Smith2018-08-151-11/+18
| | | | This includes detailing the use of `fatal-warnings` within project.conf
* docs: Add documentation of build-depends and runtime-depends fieldsJonathan Maw2018-08-141-2/+66
|
* doc: Fix install instructions for FedoraChandan Singh2018-08-121-1/+2
| | | | | | | | | `python3-arpy` package is not available on Fedora so it has to be installed using `pip`. Update instructions accordingly. For reference, here is a pipeline that failed when trying to install `arpy` using current instructions: https://gitlab.com/BuildStream/buildstream-docker-images/-/jobs/88553245.
* install_linux_distro.rst: Change install instructions for python-arpy ↵jennis/change_arch_install_instructionsJames Ennis2018-08-071-2/+13
| | | | | | | | package on Arch - python-arpy is unobtainable via pacman - Also a minor change to how we display install instructions from Fedora's dnf package manager
* source/install_linux_distro.rst: Fix formattingJavier Jardón2018-08-071-0/+2
|
* Add systemd service file examples to artifacts documentationAdam Jones2018-08-071-0/+44
| | | | change code style to ini
* source/install_linux_distro.rst: Make clearer ArchLinux packages availableJavier Jardón2018-08-071-5/+4
|
* install_linux_distro.rst: Fix broken linksJames Ennis2018-08-061-2/+2
|
* doc: Mention the Fedora packagesMathieu Bridon2018-08-061-0/+12
| | | | These aren't official yet, but they should work.
* doc: Fix junctions user guide to refer to doc/sessions, not doc/sessions-stored.Tristan Van Berkom2018-08-051-3/+4
|
* Add support for include '(@)' in project.conf and .bst filesValentin David2018-08-021-0/+44
| | | | Fixes #331.
* local plugin: validate project pathsTiago Gomes2018-08-021-2/+2
| | | | | | The autotools example had to be copied over inside of the junction example, as referring to a path outside of the project directory is now disallowed.
* install_linux_distro.rst: Add install instructons for UbuntuPhil Dawson2018-08-011-0/+24
| | | | This commit is part of the work required to resolve issue #436
* tutorials: Add workspaces tutorialPhil Dawson2018-08-013-0/+110
| | | | This is part of the work towards issue #437
* doc/sessions: Add terminal sessions for use in workspaces tutorialPhil Dawson2018-08-018-0/+213
| | | | This is part of the the work towards issue #437
* junction-elements.rst: Add missing language specifier to literalincludephil/fixup-junctions-tutorialPhil Dawson2018-07-301-0/+1
| | | | | | A missing language specifier on a literal include directive results in yaml being rendered as python code. This commit adds the :language: tag to that directive.
* using_advanced_features.rst: Added fileJames Ennis2018-07-302-0/+14
|
* junction-elements.rst: Add junctions walkthroughPhil Dawson2018-07-301-0/+72
| | | | This is part of the work towards #437.
* junctions.run: Add terminal session output for junctions walkthrough.Phil Dawson2018-07-303-0/+192
| | | | This is part of the work towards #437.
* doc: Add tutorials for setting up git and tar mirrorsJonathan Maw2018-07-273-0/+249
|
* doc: Add documentation for source mirroringJonathan Maw2018-07-272-0/+58
|
* main_install.rst: Add note to refer Windows and macOS users to dockerJames Ennis2018-07-271-1/+6
|
* Documentation typos and fixesWilliam Salmon2018-07-266-13/+13
| | | | | | 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.
* Add remote source pluginEd Baunton2018-07-251-0/+1
| | | | | | | | Add a plugin that supports downloading files verbatim from a source with an optional overridable filename and destination directory. Bumps bst format version to 10. Fixes #163
* doc/source/install_linux_distro.rst: buildstream doesn't depend on ostree or ↵jjardon/ostree_repoJavier Jardón2018-07-231-22/+15
| | | | pygobject anymore
* install_linux_distro.rst: Document plugins deps for the rest of the systemsJavier Jardón2018-07-201-2/+16
|
* install_linux_distro.rst: document plugins installed by defaultJavier Jardón2018-07-201-0/+8
|
* Added dependency to the DocsWilliam Salmon2018-07-201-0/+5
| | | | | | | | | | | These dependencies are needed to use the plugins that are installed as part of this guild. As the dependencies added are not dependencies of the core package they have been added to a separate section. The lzip package is needed to build gnome. https://wiki.gnome.org/Newcomers/BuildSystemComponent
* Docs: Update the required build packages for the rest of the systemsJavier Jardón2018-07-201-9/+10
| | | | | | | Also remove the recomendation to install psutil as we need to build other python modules anyway (like ruamel) Completes 96d07153b7817cdaeda57dd163eed52b2b1b31e8
* Docs: Update the required build packages for fedora based systems.Jordan Petridis2018-07-201-1/+1
| | | | | | `ruamel.yaml` seems to require `Python.h` header file to build. `python3-devel` is what provides it for Fedora.
* Bump required python version to 3.5Tristan Maat2018-07-181-1/+1
|
* Fix 'main install' to be explicit that it is for Linux distros onlydevcurmudgeon2018-07-172-5/+3
|
* Adding a helpful link to the exampleWilliam Salmon2018-07-171-1/+1
|
* doc/source/artifacts.rst: Update documentation for CAS artifact serverJürg Billeter2018-07-171-76/+64
|
* doc: Adding part 4 of the getting started tutorial: integration commandsTristan Van Berkom2018-06-255-0/+319
| | | | | 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/source/format_declaring.rst: Improving linkage to other parts of the manualTristan Van Berkom2018-06-251-1/+4
| | | | Adding a couple of important links to relevant material.
* doc/source/main_using.rst: Updating headline for this page.Tristan Van Berkom2018-06-251-1/+3
| | | | | The purpose of this page has changed with time, better to clarify this in the headline of the page.
* doc/source/core_plugins.rst, doc/source/install_main.rst: Fixing link anchor ↵Tristan Van Berkom2018-06-222-2/+2
| | | | | | | name In core_plugins.rst, we are already using _plugins, _plugins_build_elements, so lets call this one _plugins_sources to be consistent.
* BuildStream depends on host tools for Source pluginsJavier Jardón2018-06-222-0/+6
|
* doc/source/index.rst: fix tiny, but impactful typoPatrick Martin2018-06-221-1/+1
| | | | Fixes #435
* doc/source/examples/flatpak-autotools.rst: Reordering of titles.Tristan Van Berkom2018-06-181-10/+14
| | | | | | Place the titles of literally included `bst` files directly before the includes, and moved all related text to start below the included file for each section.
* doc: Use consistent titles when referring to files in an example projectTristan Van Berkom2018-06-182-10/+18
| | | | | | | | | | | | 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/source/using_tutorial.rst: Use a numbered ToC for the tutorialTristan Van Berkom2018-06-181-0/+1
|
* doc: Adding part 3 of the getting started tutorial: autotools elementTristan Van Berkom2018-06-185-0/+372
| | | | | | | | | 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-177-0/+365
| | | | | | | | | | | | | 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.