You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildstream.apache.org by no...@apache.org on 2020/12/29 12:37:58 UTC

[buildstream] 05/05: main_quickstart.rst: Add links/references to other sections of the docs

This is an automated email from the ASF dual-hosted git repository.

not-in-ldap pushed a commit to branch jjardon/getting_started
in repository https://gitbox.apache.org/repos/asf/buildstream.git

commit c4da7c904d1399c9a2ab43d132ea188a7f305232
Author: James Ennis <ja...@codethink.com>
AuthorDate: Mon Mar 19 14:11:40 2018 +0000

    main_quickstart.rst: Add links/references to other sections of the docs
---
 doc/source/main_authoring.rst  | 2 ++
 doc/source/main_quickstart.rst | 6 ++----
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/source/main_authoring.rst b/doc/source/main_authoring.rst
index 04a968e..4acdc0c 100644
--- a/doc/source/main_authoring.rst
+++ b/doc/source/main_authoring.rst
@@ -58,6 +58,8 @@ Build Elements
 * :mod:`pip <elements.pip>` - Pip build element
 
 
+.. _sources-section:
+
 Sources
 ~~~~~~~
 The following source types are provided with BuildStream:
diff --git a/doc/source/main_quickstart.rst b/doc/source/main_quickstart.rst
index bf93425..f786b0d 100644
--- a/doc/source/main_quickstart.rst
+++ b/doc/source/main_quickstart.rst
@@ -57,14 +57,12 @@ You can see at a glance that the upstream source tarball is referenced in the so
 Note that the ref field here stores the SHA256 checksum of the contents of the file,
 which BuildStream uses to validate the tarball after fetching it.
 The source declares that is of kind: tar. BuildStream supports various other types of sources too.
-The list of built-in sources can be found here. Support for more types of source can be added by 
-writing plugins.
+The list of built-in sources can be found :ref:`here <sources-section>`. Support for more types of source can be added by writing plugins.
 
 There are no build instructions written here because GNU Nano uses a standard build system
 that BuildStream already supports. The first line (kind: autotools) instructs BuildStream
 that it should fill in the build instructions for this element using the autotools element plugin.
-There are various ways to override the defaults which are described in the "Composition"
-section of the reference manual.
+There are various ways to override the defaults which are described in the :ref:`"Composition" <format_composition>` section of the reference manual.
 
 The depends section is a little harder to read at a glance. The filenames listed here are
 other elements within the same project. One of these provides the pkg-config tool which is built