diff options
author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-06-18 22:41:50 -0400 |
---|---|---|
committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-06-18 22:41:50 -0400 |
commit | 5b6441fa29cce761f4af0567f3608db81e8a9cbd (patch) | |
tree | 21ef23a6354af803275707d7569f455af548965c | |
parent | 48b4cb5cca6356d78d1dabab3232bb73dda1c8bc (diff) | |
download | buildstream-5b6441fa29cce761f4af0567f3608db81e8a9cbd.tar.gz |
doc: Use consistent titles when referring to files in an example project
Use the following form across the board:
``elements/foo.bst``
~~~~~~~~~~~~~~~~~~~~
.. literalinclude:: ../path/to/foo.bst
:language: yaml
Always use an example project relative path, too.
-rw-r--r-- | doc/source/examples/flatpak-autotools.rst | 20 | ||||
-rw-r--r-- | doc/source/tutorial/first-project.rst | 8 |
2 files changed, 18 insertions, 10 deletions
diff --git a/doc/source/examples/flatpak-autotools.rst b/doc/source/examples/flatpak-autotools.rst index 78a3b9a24..248b38f96 100644 --- a/doc/source/examples/flatpak-autotools.rst +++ b/doc/source/examples/flatpak-autotools.rst @@ -18,8 +18,8 @@ Project structure ----------------- -project.conf -~~~~~~~~~~~~ +``project.conf`` +~~~~~~~~~~~~~~~~ The following is a simple :ref:`project <projectconf>` definition: .. literalinclude:: ../../examples/flatpak-autotools/project.conf @@ -34,8 +34,8 @@ Note that we've added a :ref:`source alias <project_source_aliases>` for the ``https://sdk.gnome.org/`` repository to download the SDK from. -base/sdk.bst -~~~~~~~~~~~~ +``elements/base/sdk.bst`` +~~~~~~~~~~~~~~~~~~~~~~~~~ This is the :mod:`import <elements.import>` element used to import the actual Flatpak SDK, it uses an :mod:`ostree <sources.ostree>` source to download the Flatpak since these are hosted in OSTree repositories. @@ -66,8 +66,8 @@ it's important to note two things: with the appropriate symlinks setup from ``/``. -base/usrmerge.bst -~~~~~~~~~~~~~~~~~ +``elements/base/usrmerge.bst`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is another :mod:`import <elements.import>` element, and it uses the :mod:`local <sources.local>` source type so that we can stage files literally stored in the same repository as the project. @@ -84,8 +84,8 @@ As suggested by the ``.bst`` file, the symlinks themselves are a part of the project and they are stored in the ``files/links`` directory. -base.bst -~~~~~~~~ +``elements/base.bst`` +~~~~~~~~~~~~~~~~~~~~~ This is just a :mod:`stack <elements.stack>` element for convenience sake. .. literalinclude:: ../../examples/flatpak-autotools/elements/base.bst @@ -97,8 +97,8 @@ your elements to depend on without needing to know about the inner workings of the base system build. -hello.bst -~~~~~~~~~ +``elements/hello.bst`` +~~~~~~~~~~~~~~~~~~~~~~ Finally, we show an example of an :mod:`autotools <elements.autotools>` element to build our sample "Hello World" program. diff --git a/doc/source/tutorial/first-project.rst b/doc/source/tutorial/first-project.rst index 6e4635f41..1791b198b 100644 --- a/doc/source/tutorial/first-project.rst +++ b/doc/source/tutorial/first-project.rst @@ -23,8 +23,12 @@ command to create a little project structure: .. raw:: html :file: ../sessions/first-project-init.html + This will give you a :ref:`project.conf <projectconf>` which will look like this: +``project.conf`` +~~~~~~~~~~~~~~~~ + .. literalinclude:: ../../examples/first-project/project.conf :language: yaml @@ -49,6 +53,10 @@ which will import the ``hello.world`` file we've created in the previous step. Create ``elements/hello.bst`` with the following content: + +``elements/hello.bst`` +~~~~~~~~~~~~~~~~~~~~~~ + .. literalinclude:: ../../examples/first-project/elements/hello.bst :language: yaml |