summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Docs: Adding deb source plugin to the docs indexTristan Van Berkom2018-03-251-1/+1
|
* Remove unused importsJürg Billeter2018-03-251-1/+1
|
* Add documentation on sandbox optionJim MacArthur2018-03-232-0/+53
|
* source/conf.py: change copyright/author to "BuildStream Team"Javier Jardón2018-03-221-3/+3
|
* Add HACKING document to official docsJavier Jardón2018-03-222-0/+7
|
* index.rst: Fixed typo in About BuildStreamJames Ennis2018-03-201-1/+1
|
* source/conf.py: Update copyright year to 2018Javier Jardón2018-03-201-1/+1
|
* source/conf.py: Keep documentation version in syncJavier Jardón2018-03-201-2/+4
|
* source/install.rst: put Debian version under the same subsectionJavier Jardón2018-03-201-4/+8
|
* source/index.rst: Separate general and reference documentationJavier Jardón2018-03-201-4/+4
| | | | | | | Move artifacts from Installing section to general documentation This change is needed to make the TOC work correctly with the new theme
* Change theme to sphinx_rtd_themeJavier Jardón2018-03-202-25/+19
| | | | | The sphinx_rtd_theme is a sphinx theme designed to look modern and be mobile-friendly http://sphinx-rtd-theme.readthedocs.io/en/latest/index.html
* Documenting project.refsTristan Van Berkom2018-03-204-21/+143
| | | | | | | | | o Adding explanation of the `ref-storage` option in project.conf o Adjusting some adjacent relevant documentation o Adding a new projectrefs.rst section for the project.refs format itself, and linking it from the main authoring page.
* source/install.rst: Add instructions to install Arch packagesRafael Fontenelle2018-03-171-0/+9
|
* source/install.rst: Divide in two sectionsJavier Jardón2018-03-171-29/+27
| | | | | - installing from distro packages - installing from source
* docs/source/install.rst: fix terminal box for ArchLinuxJavier Jardón2018-03-171-1/+1
|
* docs/source/install.rst: Arch -> Arch LinuxJavier Jardón2018-03-171-2/+2
|
* doc/source/format.rst: Fix misnomer in documentationTristan Van Berkom2018-03-161-1/+1
| | | | | | The provided example shows the `tar` source ref being expressed with a `sha256sum` key name, lets make the example correct here and call it `ref`.
* _project.py and docs: Move defaults into the defaults yaml fileTristan Van Berkom2018-03-162-186/+202
| | | | | | | | | | | Over time, the _project.py module has regressed into expressing some defaults only hard coded into the python file instead of properly exposing their default in the base configuration file in data/projectconfig.yaml, where the default values can be observed by users. This patch rectifies that, and also restructures the relevant surrounding documentation a bit.
* doc/source/formatintro.rst: Better explanation of defaultsjmac/composition-docs-fixJim MacArthur2018-03-141-13/+12
| | | | | | | Users shouldn't see any difference between values hardcoded in Python (if there are any) and the values in projectconfig.yaml, which were previously items 0 and 1 respectively. Combined these both into 1 and made it clear that not all of project.conf is applied right away.
* doc/source/projectconfig.rst: Document `sources` overrides as since format ↵Tristan Van Berkom2018-03-061-0/+4
| | | | | | | | version 1 This was added slightly before format version 1, but was done without a version increment. Previous format versions cannot be relied upon for use of this feature.
* Removing all traces of `environment-inherit` shell configuration.Tristan Van Berkom2018-03-061-24/+20
| | | | | This is made redundant by the more complete `environment` configuration, so lets quickly remove the former in this new format version 4.
* doc/source/projectconf.rst: Documenting new `environment` shell configurationTristan Van Berkom2018-03-061-2/+38
| | | | | | | And also ammend the documentation for `host-files` to note that the paths support host side environment variable expansion. Documenting both `host-files` and `environment` to require format version 4.
* projectconf.rst: Amending documentation for `host-files`Tristan Van Berkom2018-03-041-18/+54
| | | | This is now enhanced and an API change was introduced.
* Add Filter elementJonathan Maw2018-03-011-0/+1
|
* doc/source/projectconf.rst: Documenting `host-files` shell configurationTristan Van Berkom2018-02-281-0/+42
|
* doc/source/format.rst: Document format version for junction dependency attributeTristan Van Berkom2018-02-261-0/+4
| | | | | | The junction attribute was merged fairly recently in the 1.1 series without bumping the project format version, this documents the junctions addition to be added since the closest version bump where support exists.
* doc/source/projectconf.rst: Added documentation about customizing the shellTristan Van Berkom2018-02-252-0/+57
|
* doc/source/projectconf.rst: Moving docs for `fail-on-overlaps`Tristan Van Berkom2018-02-211-17/+19
| | | | | | This is not a part of the documentation on how external plugins are loaded and referenced; lets put it in the main general section instead.
* doc: Add 'sandboxing' sectionSam Thursfield2018-02-202-0/+202
| | | | | This attempts to document and specify our current sandboxing functionality.
* doc: Update information on how plugin configuration is composedJonathan Maw2018-02-191-19/+34
| | | | | | | | It previously neglected to describe how sources were composed, and we've changed how sources are composed, recently. In addition, it was slightly confusing to have the project conf be the title of two different stages of composition.
* Add a 'sources' field to project.conf to override defaultsJonathan Maw2018-02-191-0/+22
| | | | | Equivalent to the 'elements' field, but slightly different because sources don't have accompanying yaml.
* projectconf.rst: clarify 'type option'options_typeAngelos Evripiotis2018-02-111-2/+2
| | | | | | | Reword 'Flags type options' slightly for more clarity. We use 'option type' to refer to these thingies elsewhere, adjust 'arch' to be the same way.
* Add junction support for subprojectsJürg Billeter2018-02-082-0/+5
| | | | | This introduces junctions as a new kind of elements to allow dependencies to cross project boundaries.
* Revert "image_authoring.rst: Add image creation documentation"Jürg Billeter2018-02-071-69/+0
| | | | | | This was pushed accidentally. This reverts commit 34a60189be63dc86d333ca895ce44bd24adb43c3.
* image_authoring.rst: Add image creation documentationTristan Maat2018-02-061-0/+69
|
* doc/source/install.rst: Simplified as per recommendations of Allan DayTristan Van Berkom2018-01-291-23/+38
|
* doc: Explain overlap-whitelist and fail-on-overlap164-minimise-overlaps-by-having-overlaps-raise-exceptions-unless-configured-not-toJonathan Maw2018-01-252-0/+40
|
* Documentation: Restructured toplevel documentationdocs-reorganizationTristan Van Berkom2018-01-175-70/+90
| | | | | | | | | | | | | | | | | | | | | This is intended to make things easier to find for the various types of people searching for stuff. o The installation instructions remain on the main page. o Three main separate pages have been created - Using BuildStream - Authoring BuildStream projects - Core API reference, for plugin authors o The "Authoring projects" section swallows the previous plugin index; so one can find the plugin one is looking for on the same page as the rest of the format docs o The plugin authoring section has been swallowed by the core API reference section, with a note that this is useful especially for plugin authors.
* doc: Document multiple cache supportSam Thursfield2018-01-113-20/+79
|
* Fix inconsistency in debian stretch install instructionsJonathan Maw2018-01-101-1/+1
|
* doc/source/install.rst: BuildStream depends on 'fuse' (for fusermount) and ↵jjardon/fuseJavier Jardón2018-01-081-4/+4
| | | | libfuse
* doc/source/projectconf.rst: Documenting plugin loading section.Tristan Van Berkom2018-01-082-55/+88
| | | | | | | | | | | | | This fixes issue #183. Also move the `format-version` related documentation to the first section "Essentials", beside the project name and element path, since this is a quite global option it belongs here and not hidden away with the plugin loading documentation. Also adjust the main index.rst to include the plugins sub-section as an adjacent sub-point of the project configuration (consistent with other project configuration sections).
* doc/source/install.rst: Add a note here about pip's `-e` developer optionTristan Van Berkom2018-01-081-1/+12
| | | | | It's more suitable to add this note here than to have a separate section in the HACKING.rst for this.
* doc/source/install.rst: You need python3-ruamel-yaml package in Fedorajjardon/doc_install_fedoraJavier Jardón2018-01-051-1/+1
|
* Documentation: Removing the sphinx-build3 scriptTristan Van Berkom2018-01-052-32/+13
| | | | | Instead add a comment about why this is really there, and invoke sphinx python modules with python3 directly.
* Documentation: Fix warnings, and make all warnings errors.Tristan Van Berkom2018-01-0516-2/+31
| | | | | | | | | | Some of the warnings from sphinx-build are really just warnings, but a lot of the things we want to avoid and really break documentation, like broken internal references and some invalid rst directives should really be errors. Now we treat all warnings as errors, this should ensure that any commits landing upstream never break the docs.
* doc/source/install.rst: Silence a docs generation errorTristan Van Berkom2018-01-041-2/+2
| | | | | | Fixes the warning: WARNING: /path/to/buildstream/doc/source/install.rst:45: (WARNING/2) Title underline too short.
* doc: Add cache key documentationjuerg/cache-key-docJürg Billeter2017-12-202-0/+100
|
* project: Rename required-project-version to format-versionJonathan Maw2017-12-141-2/+2
|
* doc: Remove stray documentation of obsolete required-versions fieldsJonathan Maw2017-12-141-18/+0
|
View Lorry Controller Status