summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Maat <tristan.maat@codethink.co.uk>2017-12-20 17:47:15 +0000
committerTristan Maat <tristan.maat@codethink.co.uk>2017-12-20 17:47:15 +0000
commita26f94fa84088ea840514338f4caed5c64c21bc9 (patch)
tree2044c3fa39dadf1235273ceeab172f95a63903de
parent0969d7eac20d9b548b93ec45ce658511b7d6dc0e (diff)
downloadbuildstream-spellcheck.tar.gz
buildproject.rst/install.rst: Apply minor text correctionsspellcheck
-rw-r--r--doc/source/buildproject.rst19
-rw-r--r--doc/source/install.rst12
2 files changed, 14 insertions, 17 deletions
diff --git a/doc/source/buildproject.rst b/doc/source/buildproject.rst
index 1088eebc0..57d82a495 100644
--- a/doc/source/buildproject.rst
+++ b/doc/source/buildproject.rst
@@ -3,7 +3,7 @@
Building a basic project
====
-This Section assumes you have installed Buildstream already.
+This section assumes you have installed BuildStream already.
If not, go to :ref:`installing`
@@ -15,7 +15,7 @@ Setup
If using docker, run::
- bst-here
+ bst-here
in the directory you want to use
@@ -32,7 +32,7 @@ Building
Find the .bst file that you want to build
-In this case, we will be using `gedit.bst` in elements/core
+In this case, we will be using `gedit.bst` from elements/core
from the root of the project repo run:
@@ -44,10 +44,10 @@ In this case, Gedit uses "autotools", so will therefore run:
* `autoreconf;`
* `./configure;`
-* `make;`
+* `make;`
* `make install`
-Buildstream will run the commands needed to build each plugin in the same way the user would.
+BuildStream will run the commands needed to build each plugin in the same way the user would.
This removes the need for the user to type dozens of different commands if using multiple build files
@@ -55,9 +55,9 @@ This removes the need for the user to type dozens of different commands if using
If you get an error requesting the use of ``bst track``
-This occurs when a ref has not been provided for an elements source.
+This occurs when a ref has not been provided for an element source.
-This means that buildstream does not know where to look to download something.
+This means that BuildStream does not know where to look to download something.
``bst`` :ref:`invoking_track` resolves this issue by checking for the latest commit on the branch provided in the source of the file.
@@ -71,7 +71,4 @@ Where element is the element listed in the error message
This command will go through each element and repeat the process of tracking them.
-After tracking all untracked elements
-
-Run the build command again and this time it should succeed.
-
+After tracking all untracked elements, run the build command again and this time it should succeed.
diff --git a/doc/source/install.rst b/doc/source/install.rst
index b72b086a9..28f8816b9 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -38,7 +38,7 @@ you will additionally need:
* Python 3 development libraries and headers
-* git (to checkout or install buildstream from git)
+* git (to checkout or install BuildStream from git)
Here are some examples of how to prepare the base requirements on
some distros.
@@ -106,7 +106,7 @@ requirements you need::
User installation with pip
--------------------------
-Once you have the base system dependencies, you can clone the buildstream
+Once you have the base system dependencies, you can clone the BuildStream
git repository and install it as a regular user::
@@ -117,7 +117,7 @@ git repository and install it as a regular user::
pip3 install --user .
-This will install buildstream and it's pure python dependencies directly into
+This will install BuildStream and its pure python dependencies directly into
your user's home dir in ``~/.local``
@@ -128,7 +128,7 @@ Adjust PATH
Since BuildStream is now installed under your local user's install directories,
you need to ensure that ``PATH`` is adjusted.
-A regular way to do this is to add the following line to the end of your ``~/.bashrc``::
+The regular way to do this is to add the following line to the end of your ``~/.bashrc``::
export PATH=${PATH}:~/.local/bin
@@ -158,8 +158,8 @@ to your ``~/.bash_completion``:
Upgrading with pip
~~~~~~~~~~~~~~~~~~
-To upgrade a previously install BuildStream, you will need to pull the latest
-changes and reinstall as such::
+To upgrade a previously installed BuildStream, you will need to pull
+the latest changes and reinstall as such::
pip3 uninstall buildstream