summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc/source/install.rst: Removing blank line which appeared below titleTristan Van Berkom2018-04-231-1/+0
| | | | Sections have 2 blank lines before them, and no blank line after them.
* doc/source/install.rst: minimum bubblewrap version is 0.1.2Javier Jardón2018-04-231-1/+1
|
* Revert "doc/source/install.rst: Mention bwrap version requirements"Javier Jardón2018-04-231-6/+1
| | | | | | | | | Seems this was not propperly rebased; libostree and bubblewrap requirements are already there. Also the paragraph about docker was removed in commit f0b350f158ed14c97613dc22b83ed89759b8d255 This reverts commit 7854fc5037204474d16618c657a1cd1ca12c888e.
* doc/source/index.rst: Make main documentation title sober again.Tristan Van Berkom2018-04-231-3/+3
| | | | Drop the happy welcome phrase with exclamation point.
* doc/source/install.rst: Mention bwrap version requirementsmilloni2018-04-201-1/+6
|
* doc/source/index.rst: Replace welcome paragraphjjardon/doc_readmeJavier Jardón2018-04-181-10/+7
|
* Add about pageJavier Jardón2018-04-182-0/+2
|
* main_core.rst: Change title and moved authoring, sandboxing and cachekeys ↵James Ennis2018-04-174-19/+6
| | | | documentation here
* core_framework.rst: New file containing content that was in main_core.rstJames Ennis2018-04-172-20/+19
|
* config.rst: Renamed to user_config.rst and anchors changedJames Ennis2018-04-173-3/+3
|
* invoking.rst: renamed to commands.rst (anchors also changed)James Ennis2018-04-173-5/+5
|
* Consistent titlingJames Ennis2018-04-1711-58/+58
|
* index.rst: Remove unnecessary toctree blocksJames Ennis2018-04-171-15/+0
|
* Add a general documentation sectionJames Ennis2018-04-173-5/+20
|
* main_authoring.rst: move to using buildstreamJames Ennis2018-04-173-6/+3
|
* main_install.rst: New file with install, docker and artifactsJames Ennis2018-04-175-11/+24
| | | | | | | We now have a main installing page with three sections: 1. How to install buildstream onto your machine. 2. How to run buildstream inside docker image. 3. How to install an artifact server
* index.rst: remove captionsJames Ennis2018-04-171-4/+0
|
* doc/source/format.rst: Some enhancements in how we document dependenciesTristan Van Berkom2018-04-162-33/+59
| | | | | | | | | | | | | | | | | | | | | | | | | | * Added link target in the project.conf documentation for the element-path * List elements in examples without the leading `elements/` path, this is misleading and predates the existence of the element-path * Specify "element path relative" instead of "project relative", this was also outdated. Use these opportunities to link back to the element path project.conf docs section * Document dependency attributes differently - Use a list of attributes - Link back to the first example when speaking of shorthand, instead of duplication the example in two places - Enhanced description of how junction attributes are used - Note that ordering in dependency declaration lists is not meaningful This is an incorporation of Javier Jardón's patch for issue #358 This fixes issue #358.
* buildstream/plugin.py, doc/source/projectconf.rst: Changed policy for core ↵Tristan Van Berkom2018-04-151-25/+6
| | | | | | | | | | | | | | plugin format revisioning The policy for format revisioning of core plugins maintained in BuildStream now changes such that we revision all plugins under the same core format version. This means that format extensions in plugins should be revisioned in the global _versions.BST_FORMAT_VERSION along with the core format, this simplifies parameterization of project.conf for usage of core plugins. This did not really require any code support as our plugins have never been revisioned before.
* source/install.rst: Update ArchLinux installation instructionsJavier Jardón2018-04-111-2/+2
|
* doc/source/install.rst: Update list of base requirementsJavier Jardón2018-04-111-2/+3
|
* doc/source/projectconf.rst: Document restrictions on option and option ↵Tristan Van Berkom2018-04-061-0/+11
| | | | variable names.
* doc/source/projectconf.rst: Properly document the project name.Tristan Van Berkom2018-04-061-2/+10
| | | | This is a part of issue #339
* doc/source/projectrefs.rst: Ammended documentation for project.refsTristan Van Berkom2018-04-051-22/+25
| | | | This was missing the main `projects` toplevel key
* source/index.rst: Add resources page to "contributing" sectionJavier Jardón2018-03-291-0/+1
|
* Add basic resources pageJavier Jardón2018-03-291-0/+10
| | | | with info about git repo, IRC, mailing list and big tracker
* docs: Remove orphan tag from all pagesJavier Jardón2018-03-2815-15/+0
| | | | | | This is not needed anymore as all documented are part of the index This is a part of the fix for #246
* source/main_authoring.rst: Use toctree instead normal listJavier Jardón2018-03-281-33/+9
| | | | | | So index appear in left menu This is a part of the fix for #246
* source/main_using.rst: Use toctree instead normal listJavier Jardón2018-03-281-3/+5
| | | | | | So index appear in left menu This is a part of the fix for #246
* source/main_core.rst: Use toctree instead normal listJavier Jardón2018-03-281-4/+5
| | | | | | So index appear in left menu This is a part of the fix for #246
* install.rst: Change ~ for $HOME just incase it expands to characters bash ↵James Ennis2018-03-271-1/+1
| | | | does not like
* install.rst: Inform the user to restart their terminal once their PATH is ↵James Ennis2018-03-271-0/+4
| | | | adjusted
* 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.
View Lorry Controller Status