summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* _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.
* doc: Show a non-TLS remote-execution config. exampleMartin Blanchard2019-02-282-6/+2
| | | | https://gitlab.com/BuildStream/buildstream/issues/799
* Document how to refer to cross-junction dependencies inlinechandan/junction-dependency-formatChandan Singh2019-02-261-0/+35
| | | | | | In the previous commit, we added support to express cross-junction dependencies inline as simple strings. Document it along with the version in which the feature was added.
* doc: Update configuration examples with 'instance-name'Martin Blanchard2019-02-222-4/+7
|
* doc/./arch_sandboxing: no OSTree artifact cacheaevri/doc_arch_depsAngelos Evripiotis2019-02-201-6/+6
| | | | | As of commit 1f8b4aa290a908a697f008a29ea143a9320dd639, we're no longer using the OSTree artifact cache. Update accordingly.
* doc/./arch_sandboxing: reword 'user provided user'Angelos Evripiotis2019-02-201-1/+1
|
* doc/./arch_sandboxing: 'read only'->'read-only'Angelos Evripiotis2019-02-201-1/+1
| | | | I read this wrong initially, the hyphen would have helped me here.
* doc/./arch_cachekeys: note no direct runtime depsAngelos Evripiotis2019-02-201-0/+3
| | | | | | | | I was mistaken on this point in my first reading. The sentence on strong and weak key equivalency made me check my assumptions. Help others with the same misunderstanding by explicitly calling this out in a new paragraph.
* doc/./arch_cachekeys: consistent full-stopsAngelos Evripiotis2019-02-201-5/+5
|
* doc/./arch_cachekeys: JSON now, not dict pickleAngelos Evripiotis2019-02-201-1/+1
|
* doc/./arch_scheduler: fix 'imerative' typoAngelos Evripiotis2019-02-201-1/+1
|
* doc/./arch_scheduler: fixup "it's" typosAngelos Evripiotis2019-02-201-3/+3
| | | | | | "it's" is always short for "it is" or "it has". The possesive pronoun for "it" is "its", like "his".
* doc/../arch_dependency_model: transient/transitiveAngelos Evripiotis2019-02-201-2/+3
|
* doc/./arch_data_model:edit comp stages for clarityAngelos Evripiotis2019-02-201-3/+4
|
* doc/./arch_data_model: add some missing full-stopsAngelos Evripiotis2019-02-201-11/+11
|
* doc/./arch_data_model: fixup affect/effectAngelos Evripiotis2019-02-201-3/+3
|
* cachedir: add new dir option that's default root to other dirsRaoul Hidalgo Charman2019-02-192-5/+2
| | | | | | Makes artifactdir and builddir obsolete. Fixes #870
* doc/badges.py: Fix catching of CalledProcessErrorChandan Singh2019-02-181-1/+1
| | | | | | Since `CalledProcessError` is defined by the `subprocess` module, it must be caught as `subprocess.CalledProcessError`, and not as simply `CalledProcessError`.
* Fixup refs to 'bst track'Angelos Evripiotis2019-01-281-2/+2
| | | | | Now that 'bst track' is obsolete, change guidance to refer to the replacement 'bst source track' instead.
* format_project.rst: Add documentation for default targetsJürg Billeter2019-01-241-0/+38
|
* Change bst checkout/pull/push references to bst artifact checkout/pull/pushJames Ennis2019-01-221-1/+1
|
* using_commands.rst: Add artifact log subcommandJames Ennis2019-01-221-0/+7
|
* using_commands.rst: Split out the artifact subcommandsJames Ennis2019-01-223-22/+31
|
* using_commands.rst: Add the source checkout commandJames Ennis2019-01-221-0/+7
|
* using_commands.rst: Split out top level commands and subcommand groupsJames Ennis2019-01-221-15/+27
|
* _cas: Rename artifactcache folder and move that to a root moduleRaoul Hidalgo Charman2019-01-161-1/+1
| | | | | | | | | Other components will start to reply on cas modules, and not the artifact cache modules so it should be organized to reflect this. All relevant imports have been changed. Part #802
* Add support for https channel to remote execution and actions serversvalentindavid/remote_execution_configurationValentin David2019-01-091-3/+0
| | | | Fixes #780.
* Add support for user remote execution configurationValentin David2019-01-092-0/+52
| | | | Fixes #631.
* doc/Makefile: Update comment about sphinx entrypointchandan/update-doc-makefile-noteChandan Singh2019-01-021-4/+4
| | | | | | https://github.com/sphinx-doc/sphinx/issues/4375 has been closed as `wontfix`. Update the comment in doc/Makefile that mentions it, based on the discussion on the issue.
* doc: Add note about valid element namesChandan Singh2018-12-311-0/+24
|
* Documentation: Include instance-name in remote execution documentationraoul/627-RE-instance-configJim MacArthur2018-12-181-1/+10
|
* Remove source bundle commandPhil Dawson2018-12-121-7/+0
| | | | This is part of the work towards #672
* doc: Point out that element is optional when commands are run from the workspacejonathan/workspace-fragment-guess-elementJonathan Maw2018-12-113-1/+57
| | | | This is a part of #222
* types.py: Moving CoreWarnings to the types.py moduleTristan Van Berkom2018-12-061-1/+1
| | | | | | This also ensures it is exposed via the main buildstream __init__.py file, fixes the imports of CoreWarnings, and adjusts the documentation links to point to the right place.
* format_project.rst: Add docs for action-cache-serviceRaoul Hidalgo Charman2018-12-051-0/+7
| | | | Part of #628
* format_project.rst: Add docs for OptionOSRaoul Hidalgo Charman2018-12-051-0/+24
|