Skip to content

build-from-scratch: add HTML links to source code thanks to extlinks #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marc-hb merged 1 commit into from
Apr 9, 2020
Merged

build-from-scratch: add HTML links to source code thanks to extlinks #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['breathe', 'sphinx.ext.graphviz', 'sphinxcontrib.plantuml','sphinx.ext.todo']
extensions = ['breathe', 'sphinx.ext.graphviz', 'sphinxcontrib.plantuml',
'sphinx.ext.todo', 'sphinx.ext.extlinks',
]


graphviz_output_format='svg'
graphviz_dot_args=[
Expand Down Expand Up @@ -155,6 +158,13 @@
#numfig_secnum_depth = (2)
numfig_format = {'figure': 'Figure %s', 'table': 'Table %s', 'code-block': 'Code Block %s'}

extlinks = {
'git-sof-master':
('https://github.com/thesofproject/sof/tree/master/%s', ""),
'git-alsa':
('https://git.alsa-project.org/?p=%s.git', ""),
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand Down
16 changes: 12 additions & 4 deletions getting_started/build-guide/build-from-scratch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ sources. Refer to this short guide: https://cmake.org/install/
Build alsa-lib and alsa-utils
-----------------------------

This project requires some new features in alsa-lib and alsa-utils, so build
the newest ALSA from source code.
This project requires some new features in :git-alsa:`alsa-lib` and
:git-alsa:`alsa-utils`, so build the newest ALSA from source code.

.. warning::

Expand Down Expand Up @@ -306,8 +306,9 @@ After the SOF environment is set up, clone the *sof* repo.
One-step rebuild from scratch
-----------------------------

To rebuild |SOF| in just one step, use the following script after
setting up the environment.
To rebuild |SOF| in just one step, use
:git-sof-master:`scripts/xtensa-build-all.sh` after setting up the
environment.

Build the firmware for all platforms.

Expand Down Expand Up @@ -498,10 +499,17 @@ Step 4 Build topology and tools
One-step rebuild from scratch
-----------------------------

Without any argument :git-sof-master:`scripts/build-tools.sh` rebuilds
only the minimum subset of :git-sof-master:`tools/`.

.. code-block:: bash

cd ~/work/sof/sof/
./scripts/build-tools.sh
./scripts/build-tools.sh -h
usage: ./scripts/build-tools.sh [-t|-f]
[-t] Build test topologies
[-f] Build fuzzer"

Incremental build
-----------------
Expand Down