diff options
| author | Michael Olbrich <m.olbrich@pengutronix.de> | 2023-06-23 11:41:36 +0200 |
|---|---|---|
| committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2023-06-23 11:42:02 +0200 |
| commit | 85ab3d3ace36066ae6eb877c4c8ea613b630b5fd (patch) | |
| tree | 67405768bfd752b703cd46fb13aeeac0093216d8 | |
| parent | 315b6603cac1eb2cb31534feaa29486b4f865194 (diff) | |
| download | ptxdist-85ab3d3ace36066ae6eb877c4c8ea613b630b5fd.tar.gz ptxdist-85ab3d3ace36066ae6eb877c4c8ea613b630b5fd.tar.xz | |
doc: clarify that there is no SELAS.BSP-Pengutronix-Example BSP
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
| -rwxr-xr-x | bin/ptxdist | 4 | ||||
| -rw-r--r-- | doc/environment.rst | 15 |
2 files changed, 18 insertions, 1 deletions
diff --git a/bin/ptxdist b/bin/ptxdist index 745ef9170..511af3be9 100755 --- a/bin/ptxdist +++ b/bin/ptxdist @@ -1018,12 +1018,14 @@ drop() { create_docs() { local builder srcdir outdir dir entry + local -a args builder="${1}" outdir=${PTXDIST_WORKSPACE}/Documentation if [ "${PTXDIST_TOPDIR}" -ef "${PTXDIST_WORKSPACE}" ]; then srcdir="${PTXDIST_TEMPDIR}/docs" + args=( "-t" "ptxdistonly" ) else srcdir="${STATEDIR}/docs" rm -rf "${srcdir}" && @@ -1039,7 +1041,7 @@ create_docs() { done done && check_virtualenv && - sphinx-build -b "${builder}" -d "${outdir}/.doctrees" "${srcdir}" \ + sphinx-build -b "${builder}" -d "${outdir}/.doctrees" "${args[@]}" "${srcdir}" \ "${outdir}/${builder}" && if [ "${builder}" = "latex" ]; then sed -i s/pdflatex/xelatex/ ${outdir}/${builder}/Makefile diff --git a/doc/environment.rst b/doc/environment.rst index 21156033f..f35d0b43e 100644 --- a/doc/environment.rst +++ b/doc/environment.rst @@ -14,6 +14,21 @@ http://www.ptxdist.org. This website provides all required packages and documentation (at least for software components which are available to the public). +.. only:: ptxdistonly + + .. note:: + The PTXdist documenation can be built for a specific BSP. That makes it + possible to add BSP specific chapters to the documentation, the BSP is + referenced by its name and the PTXdist and toolchain versions are + correctly specified for this BSP. + + This instance of the documentation is built without a BSP. So + *|ptxdistBSPName|* is used as a placeholder for the BSP name. There is no + *|ptxdistBSPName|* BSP! + + To start experimenting with PTXdist, `DistroKit <https://git.pengutronix.de/cgit/DistroKit/>`_ + can be used. + In order to build |ptxdistBSPName|, the following source archives have to be available on the development host: |