summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc/source/using_developing.rst: Renamed to "Developing"Tristan Van Berkom2020-04-171-5/+5
| | | | | | | | Calling this "Developing using BuildStream" is just redundant, seeing that this is a part of a BuildStream user guide already. Also, rephrased the introduction text (which appears on a page which is rarely frequented anyway).
* doc/source/using_tutorial.rst: Renamed to "Getting started"Tristan Van Berkom2020-04-171-2/+2
| | | | | | | | | | | | This section of the user manual describes the basics of creating your first BuildStream project, while we've discussed this in terms of a "Getting started" guide while developing it, we ended up naming this a "Tutorial" because of it's walkthrough nature. Due to it's name as a Tutorial, developers (our target audience) have a tendency to avoid it and look for more terse and advanced material, while this material could be more suitable for getting started.
* doc/source/format_intro.rst: Clarifications around directivesTristan Van Berkom2020-04-171-15/+26
| | | | | | | | | | | | | | Clarification of (@) include documentation The "important" annotation here was very confusing to read, rewrote this section to clarify that files included across a junction cannot be used to inform the declaration of a junction, as this can present a circular dependency. Clarification around conditionals and includes Clarify that conditional statements are always resolved in the context of the project where the conditional statement was declared.
* doc/source/main_glossary.rst: rename 'Core Plugin' -> 'Core plugin'Tristan Van Berkom2020-04-171-2/+2
| | | | Fix an error in documentation build.
* doc/source/main_glossary.rst: Fix docs build errorstristan/fix-docs-build-errorTristan Van Berkom2020-04-111-2/+2
| | | | | Some of the referenced terms within the glossary were not using the capitalization for which the term was declared.
* Docs: Add doc note about directories to core pluginswillsalmon/directorynoteWilliam Salmon2020-02-261-0/+6
|
* exceptions: Expose ErrorDomain, ErrorLoadReasonThomas Coldrick2020-01-231-0/+1
| | | | | | | Plugin tests are already accessing this API, but using imports from private modules. For motivation for this to be exposed publicly, note that ErrorDomain is an argument for most things in runcli.py, and LoadErrorReason may be another.
* doc/sample_plugin: Update name of entry point groupChandan Singh2020-01-171-4/+1
| | | | | | | | Update sample plugin documentation based on the recent change to entry point group for plugins. While I'm here, also remove the unnecessary dependency on `setuptools` from the sample plugin.
* Remove "deb" surce plugin, it has beem moved to bst-plugins-experimentaljjardon/move_deb_sourceJavier Jardón2020-01-171-1/+0
|
* Drop support for `setup.py test`Chandan Singh2019-12-231-9/+15
| | | | | | | | | | | | | | Drop support for running tests via `setup.py test`, that is considered deprecated. `tox` is our primary frontend for running tests, so this change ensures that we don't have to support multiple ways of running tests. For testing against a specific installation environment, `tox` is not quite practical. But in these cases, one can run `pytest` directly. So, there is no need for this additional indirection. This was discussed in the following mailing list thread: https://mail.gnome.org/archives/buildstream-list/2019-December/msg00006.html.
* doc/coding_guidelines: Drop section about line lengthsChandan Singh2019-11-271-15/+0
| | | | | | | Since we format our code using Black, contributors don't have to think about line lengths themselves. In fact, Black is going to rewrite the files anyway so it's not even possible to make a judgement call in most cases.
* doc: Add glossary of common termsChandan Singh2019-11-275-0/+141
| | | | | Start a new glossary document, aimed at helping newcomers relevant links to more detailed documents.
* doc/examples/flatpak-autotools: remove references to sdk.gnome.orgAbderrahim Kitouni2019-11-195-8/+8
| | | | download from flathub instead, and update to 1.6 as flathub doesn't include 1.4
* Start linting doc/source/conf.pyChandan Singh2019-11-141-42/+37
| | | | | | | | | | | Add `doc/source/conf.py` to the filelist for Black and Pylint. Previously this file was not covered by any of the linters, so this patch includes one-off sweeping changes for the formatting. To make pylint happy, we had to disable a warning about defining a variable called `copyright` since that's a built-in. It's unlikely that we will ever need the built-in `copyright()` in this module, so it seems safe to disable it.
* doc/source/hacking: Remove pycodestyle, add BlackChandan Singh2019-11-142-16/+26
| | | | | | | | | | | Now that code formatting is managed by Black, and we don't need to run `pycodestyle` separately, remove corresponding mentions from hacking documentation. Add documentation on how to run Black. Move out linting and formatting into a separate section for better readability.
* 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
View Lorry Controller Status