[Notes] [Git][BuildStream/buildstream][master] 2 commits: Documentation

Javier Jardón pushed to branch master at BuildStream / buildstream

Commits:

7ceacfea

by William Salmon at 2018-07-26T14:32:49Z

Documentation typos and fixes

Daniel went through the Doc's etc and made a list of suggestions.
These are the result of the most easily patched suggestions and
one or two thing that I noticed as well.

8c9fd9e4

by Javier Jardón at 2018-07-26T15:32:16Z

Merge branch 'willsalmon/documentation_form_notes' into 'master'

Documentation typos and fixes

See merge request BuildStream/buildstream!569

7 changed files:

HACKING.rst
doc/source/examples/flatpak-autotools.rst
doc/source/format_declaring.rst
doc/source/format_project.rst
doc/source/install_docker.rst
doc/source/install_linux_distro.rst
doc/source/tutorial/autotools.rst

Changes:

HACKING.rst

@@ -294,7 +294,7 @@ committed with that.
  To do this, first ensure you have ``click_man`` installed, possibly
  with::
 -  pip install --user click_man
 +  pip3 install --user click_man
  Then, in the toplevel directory of buildstream, run the following::
@@ -450,7 +450,7 @@ To run the tests, just type::
  At the toplevel.
  When debugging a test, it can be desirable to see the stdout
 -and stderr generated by a test, to do this use the --addopts
 +and stderr generated by a test, to do this use the ``--addopts``
  function to feed arguments to pytest as such::
    ./setup.py test --addopts -s
@@ -530,7 +530,7 @@ tool.
  Python provides `cProfile <https://docs.python.org/3/library/profile.html>`_
  which gives you a list of all functions called during execution and how much
 -time was spent in each function. Here is an example of running `bst --help`
 +time was spent in each function. Here is an example of running ``bst --help``
  under cProfile:
      python3 -m cProfile -o bst.cprofile -- $(which bst) --help

doc/source/examples/flatpak-autotools.rst

@@ -58,7 +58,7 @@ it's important to note two things:
  * **source**: We only want to extract the ``files/`` directory from the SDK,
    This is becase Flatpak runtimes dont start at the root of the OSTree checkout,
 -  instead the actual files start in the ``files//`` subdirectory
 +  instead the actual files start in the ``files/`` subdirectory
  * **target**: The content we've extracted should be staged at ``/usr``

doc/source/format_declaring.rst

@@ -400,7 +400,7 @@ dependency and that all referenced variables are declared, the following is fine
     It should be noted that variable resolution only happens after all
     :ref:`Element Composition <format_composition>` has already taken place.
 -   This is to say that overriding ``%{version}`` at a higher priority will effect
 +   This is to say that overriding ``%{version}`` at a higher priority will affect
     the final result of ``%{release-text}``.

doc/source/format_project.rst

@@ -548,7 +548,7 @@ The defaults environment for the build sandbox is defined here.
       PATH: /usr/bin:/bin:/usr/sbin:/sbin
  Additionally, the special ``environment-nocache`` list which specifies
 -which environment variables do not effect build output, and are thus
 +which environment variables do not affect build output, and are thus
  not considered in the calculation of artifact keys can be defined here.
  .. code:: yaml
@@ -558,7 +558,7 @@ not considered in the calculation of artifact keys can be defined here.
  Note that the ``environment-nocache`` list only exists so that we can
  control parameters such as ``make -j ${MAXJOBS}``, allowing us to control
 -the number of jobs for a given build without effecting the resulting
 +the number of jobs for a given build without affecting the resulting
  cache key.

doc/source/install_docker.rst

@@ -38,8 +38,8 @@ be able to integrate with Bash tab-completion if you invoke it in this way.
  Two Docker volumes are set up by the ``bst-here`` script:
 - * buildstream-cache -- mounted at ``~/.cache/buildstream``
 - * buildstream-config -- mounted at ``~/.config/``
 + * ``buildstream-cache --`` mounted at ``~/.cache/buildstream``
 + * ``buildstream-config --`` mounted at ``~/.config/``
  These are necessary so that your BuildStream cache and configuration files
  persist between invocations of ``bst-here``.

doc/source/install_linux_distro.rst

@@ -77,17 +77,17 @@ setup as described `here <https://backports.debian.org/Instructions/>`_
  By adding the following line to your sources.list::
 -  deb http://ftp.debian.org/debian stretch-backports main
 +  deb http://deb.debian.org/debian stretch-backports main
  And then running::
 -  sudo apt-get update
 +  sudo apt update
  At this point you should be able to get the system requirements for the default plugins with::
 -  sudo apt-get install \
 +  sudo apt install \
        bzr git lzip patch python3-arpy python3-gi
 -  sudo apt-get install -t stretch-backports \
 +  sudo apt install -t stretch-backports \
        gir1.2-ostree-1.0 ostree
  Buster or Sid
@@ -177,8 +177,8 @@ checkout::
    cd /path/to/buildstream
    git pull --rebase
 -If you did not specify the ``-e`` option at install time, you will
 -need to cleanly reinstall BuildStream::
 +If you did not specify the ``-e`` option at install time or the dependancies
 +have changed, you will need to cleanly reinstall BuildStream::
    pip3 uninstall buildstream
    cd /path/to/buildstream

doc/source/tutorial/autotools.rst

@@ -109,7 +109,7 @@ changes the output.
  Observe where the variables are declared in the :ref:`builtin defaults
  <project_builtin_defaults>` and :mod:`autotools <elements.autotools>` element
 -documentation, and how overriding these affects the resolved set of variables.
 +documentation, and how overriding these effects the resolved set of variables.
  Using the project

[Notes] [Git][BuildStream/buildstream][master] 2 commits: Documentation typos and fixes

Javier Jardón pushed to branch master at BuildStream / buildstream

Commits:

7 changed files:

Changes: