summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* format_project.rst: De-obfuscate element/package differencestlater/plugin-documentation-improvementTristan Maat2019-10-251-1/+1
| | | | | | When the package and project have the same name, it can be a little confusing what these things actually mean. This commit makes it a bit more obvious that the two can (and will often) be different.
* doc/Makefile: exit 1 if running bst command failschiaratolentino/fix-docsctolentino82019-10-071-3/+1
|
* doc/bst2html.py: Error out if bst command in doc failsctolentino82019-10-071-2/+5
|
* doc/sessions/junctions.run: Fix typo in 'remove-dir' optionctolentino82019-10-071-1/+1
|
* Update doc commands to use 'artifact checkout'ctolentino82019-10-071-1/+1
|
* Update doc commands to use 'source fetch'ctolentino82019-10-075-5/+5
|
* CONTRIBUTING.rst: Add UI sectionJames Ennis2019-09-161-0/+78
| | | | | | Now that the frontend has been mostly reworked/standardized, this patch attempts to put our some guidelines/information in around UI contributions.
* using_commands.rst: Add internal X-referencesJames Ennis2019-09-161-0/+6
| | | | | This patch adds internal cross references for the artifact and source commands.
* using_commands.rst: Add show and list-contentsJames Ennis2019-09-161-0/+14
| | | | | This patch ensures that we document the recently introduced artifact subcommands "show" and "list-contents".
* coding_guidelines.rst: Inline comments require 2 whitespacesjennis/split_contributingJames Ennis2019-09-131-1/+1
|
* coding_guidelines.rst: Fix typo in frobiliciouslyJames Ennis2019-09-131-2/+2
|
* grpc_protocol.rst: Rename title to be more descriptiveJames Ennis2019-09-131-2/+2
|
* writing_documentation.rst: Rename title to be more descriptiveJames Ennis2019-09-131-2/+2
|
* using_the_testsuite.rst: Rename title to be more descriptiveJames Ennis2019-09-131-2/+2
|
* CONTRIBUTING.rst: Split up CONTRIBUTING into smaller filesJames Ennis2019-09-1310-1/+1902
| | | | | | | | Our contributing has got way too big. This patch aims to split it up into sensible files. These are found in "Further information". Closes #1116
* Use distutils plugin from bst-plugins-experimentalJavier Jardón2019-09-121-1/+0
|
* Fail if we try to build a BST_FORMAT_VERSION we do not support anymorejjardon/BST_FORMAT_VERSIONJavier Jardón2019-09-128-8/+8
| | | | | bst-1.x support BST_FORMAT_VERSION == 17, as that is not supported by master I think is ok to set BST_FORMAT_VERSION_MIN = 18
* Update documentation to explain split cachesTristan Maat2019-09-062-0/+59
|
* doc/source/format_declaring.rst: Documenting strict dependenciesTristan Van Berkom2019-08-312-0/+13
| | | | | | This adds documentation on the new keyword `strict` in dependency declarations, and adds a link to the strict mode user config section.
* Move qmake plugin to bst-plugins-experimentalcoldtom/move-qmakeThomas Coldrick2019-08-141-1/+0
|
* Move modulebuild plugin to bst-plugins-experimentalThomas Coldrick2019-08-141-1/+0
| | | | Continuing moving plugins over to bst-plugins-experimental.
* Move makemaker plugin to bst-plugins-experimentalThomas Coldrick2019-08-121-1/+0
| | | | Continuing moving plugins to bst-plugins-experimental.
* Move make plugin to bst-plugins-experimentalcoldtom/move-makeThomas Coldrick2019-08-091-1/+0
|
* Move meson element to bst-plugins-experimentalThomas Coldrick2019-08-081-1/+0
|
* doc/source/core_plugins.rst: bst-external -> bst-plugins-experimentalJavier Jardón2019-08-081-1/+1
|
* Move cmake plugin to bst-plugins-experimentalcoldtom/move-cmakeThomas Coldrick2019-08-081-1/+0
| | | | | | | | | | | | It was agreed on the mailing list to move all plugins to a single repository, before moving them into domain-specific repositories. As a result it seems reasonable to move everything to the bst-plugins-experimental repo as this stepping stone, rather than creating a whole new repo. This commit starts the process of moving things over by moving only the cmake plugin to bst-plugins-experimental, and altering the tests to reflect the new location.
* format_project.rst: Add required push flag to documentationJames Ennis2019-08-061-0/+2
| | | | | When declaring artifact/source servers which we want to push to, we must set a "push" boolean
* doc/source/format_project.rst: Fix tiny typoTristan Maat2019-07-291-2/+1
|
* node: Add 'get_str_list' on 'MappingNode'Benjamin Schubert2019-07-171-1/+1
| | | | | | `mapping.get_sequence(...).as_str_list()` is a very common pattern seen both in plugins and the core. Adding a helper to reduce the number of operations will make usage smoother
* node: document public APIBenjamin Schubert2019-07-151-0/+1
|
* _yaml: Decomission 'dump()'. 'roundtrip_dump' is an equivalent function nowBenjamin Schubert2019-07-151-1/+1
| | | | | Remove completely '_yaml.dump()' and replace all notions and call by 'roundtrip_dump'
* _yaml: Remove 'node_items' and add 'MappingNode.items()'Benjamin Schubert2019-07-151-1/+2
| | | | | | One difference is that 'MappingNode.items()' does not strip the provenance from scalars and lists, which ends up not affecting the code much.
* doc/bst2html: Remove usage of 'node_get' and use new APIBenjamin Schubert2019-07-151-13/+11
|
* doc/source/using_config.rst: Add pull-artifact-files optionRaoul Hidalgo Charman2019-07-111-2/+6
| | | | Part of #1043
* Rename (spawn, fork) -> 'start process'Angelos Evripiotis2019-06-061-2/+2
| | | | | | | | | | | | | | Avoid confusion by not referring to starting another process as 'spawning'. Note that 'spawn' is a process creation method, which is an alternative to forking. Say 'create child process' instead of 'fork' where it doesn't harm understanding. Although we currently only use the 'fork' method for creating subprocesses, there are reasons for us to support 'spawn' in the future. More information on forking and spawning: https://docs.python.org/3/library/multiprocessing.html#contexts-and-start-methods
* _yaml.pyx: Forbid expected_type=Mapping, and remove isinstance checkBenjamin Schubert2019-06-031-3/+2
| | | | | | | | | | | Calls to `isinstance` can be particularily costly. Using type() is much faster. The only known case where the `isinstance` was useful is for dictionnaries where we would ask for a 'Mapping' instead. Disallowing 'Mapping' for expected_type considerably speeds up the calls to this functions. Also add into NEWS
* docs: Update configuring cache serverraoul/1024-artifact-docsRaoul Hidalgo Charman2019-05-314-33/+40
| | | | | | | | Now that we have both artifact and source caches the documentation is updated to reflect that. Some sections headings/links etc. have been expanded and changed. Part of #1025
* doc: Add architecture section on cachesRaoul Hidalgo Charman2019-05-313-0/+71
| | | | Part of #1024
* docs: update to reflect artifact as a protoRaoul Hidalgo Charman2019-05-311-6/+7
| | | | Part of #1024
* Move source from 'buildstream' to 'src/buildstream'Chandan Singh2019-05-213-6/+6
| | | | | | This was discussed in #1008. Fixes #1009.
* Remove OSTree plugin; It lives now in the bst-plugins-experimental repoJavier Jardón2019-05-142-1/+5
|
* doc/source/format_declaring.rst: Fix the YAML blockMathieu Bridon2019-04-221-1/+1
| | | | String starting with a "%" character need to be quoted.
* doc: Fix the build with Sphinx 2.0Mathieu Bridon2019-04-221-1/+1
| | | | | | | | | | | | Sphinx 1.7, released in February 2018 moved the sphinx.apidoc module to sphinx.ext.apidoc, with an alias and a deprecation warning in place so users know to port their code. The compatibility alias was removed in Sphinx 2.0, so we need to move to the new module name. Fortunately, since the new module name is more than a year old, this shouldn't break anything for anybody.
* plugintestutils: Rename 'plugintestutils' package to 'testing'phil/rename-plugintestutilsPhil Dawson2019-04-161-1/+1
| | | | | | | | | - Rename plugintestutils to testing. - Don't run the tests from bst-plugins-template. This imports buildstream.plugintestutils so will have to be disabled to get through CI. This can be re nabled once bst-plugins-template has been patched.
* docs: Add generated docs for buildstream.plugintestutilsPhil Dawson2019-04-121-0/+1
|
* using_config.rst: Add source cache documentationRaoul Hidalgo Charman2019-03-251-0/+46
| | | | Part of #440
* format_project.rst: Add source cache documentationRaoul Hidalgo Charman2019-03-251-0/+27
| | | | Part of #440
* Added doc's for workspace reset --softpointswaves/softresetWilliam Salmon2019-03-213-0/+45
|
* docs: Add bst artifact delete to using_commands.rstJames Ennis2019-03-131-0/+7
|
* doc/source/core_plugins.rst: Add link to bst-plugins-containerChandan Singh2019-03-121-0/+1
| | | | | | https://gitlab.com/BuildStream/bst-plugins-container has now had its first (and second and third too) release, add it to the list of known external plugins.
View Lorry Controller Status