[PATCH 1/2] Documentation: user: versioning: fix formatting

[PATCH 1/2] Documentation: user: versioning: fix formatting

[Ahmad Fatoum]

Apparently, Sphinx is space sensitive in literal ``blocks`` and
currently interprets <space>`` literally and doesn't end the literal
then.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/user/versioning.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/user/versioning.rst b/Documentation/user/versioning.rst
index 0c3001b97433..0a8095a2e085 100644
--- a/Documentation/user/versioning.rst
+++ b/Documentation/user/versioning.rst
@@ -9,7 +9,7 @@ information:
 
   * When built from git, ``scripts/setlocalversion`` will factor in
     git revision information into the version string.
-  * The ``EXTRAVERSION = `` in the top-level ``Makefile`` can be used
+  * The ``EXTRAVERSION =`` in the top-level ``Makefile`` can be used
     to add a suffix to the version. This is useful if patches are applied
     on top of the tarball release.
   * The build host can set the ``BUILDSYSTEM_VERSION`` environment variable
-- 
2.39.5

[PATCH 2/2] Documentation: user: versioning: reduce indentation

[Ahmad Fatoum]

The bullet points are indented a lot, reduce them to normal.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/user/versioning.rst | 36 +++++++++++++++----------------
 1 file changed, 18 insertions(+), 18 deletions(-)

diff --git a/Documentation/user/versioning.rst b/Documentation/user/versioning.rst
index 0a8095a2e085..d8e2fdbc4574 100644
--- a/Documentation/user/versioning.rst
+++ b/Documentation/user/versioning.rst
@@ -7,15 +7,15 @@ In addition to the usual barebox release (e.g. ``v2025.03.0``), the
 version number can be extended to encode integration-specific version
 information:
 
-  * When built from git, ``scripts/setlocalversion`` will factor in
-    git revision information into the version string.
-  * The ``EXTRAVERSION =`` in the top-level ``Makefile`` can be used
-    to add a suffix to the version. This is useful if patches are applied
-    on top of the tarball release.
-  * The build host can set the ``BUILDSYSTEM_VERSION`` environment variable
-    prior to executing ``make`` to encode a board support package version.
-    This is useful to encode information about built-in environment
-    and firmware.
+* When built from git, ``scripts/setlocalversion`` will factor in
+  git revision information into the version string.
+* The ``EXTRAVERSION =`` in the top-level ``Makefile`` can be used
+  to add a suffix to the version. This is useful if patches are applied
+  on top of the tarball release.
+* The build host can set the ``BUILDSYSTEM_VERSION`` environment variable
+  prior to executing ``make`` to encode a board support package version.
+  This is useful to encode information about built-in environment
+  and firmware.
 
 Query from barebox
 ^^^^^^^^^^^^^^^^^^
@@ -32,17 +32,17 @@ Query from OS
 The barebox version (formatted as ``barebox-$version``) can be queried
 after boot by different means:
 
- * If the OS is booted with device tree, barebox will fixup a
-   ``/chosen/barebox-version`` property into the kernel device tree with
-   the version string. Under Linux, this can be accessed at:
+* If the OS is booted with device tree, barebox will fixup a
+  ``/chosen/barebox-version`` property into the kernel device tree with
+  the version string. Under Linux, this can be accessed at:
 
-   * ``/sys/firmware/devicetree/base/chosen/barebox-version``
-   * ``/proc/device-tree/base/chosen/barebox-version``
+ * ``/sys/firmware/devicetree/base/chosen/barebox-version``
+ * ``/proc/device-tree/base/chosen/barebox-version``
 
- * If the system is booted through barebox as EFI application (payload),
-   a ``LoaderInfo`` EFI variable with the systemd vendor GUID will
-   be set to the version string. Under Linux, the string is shown in
-   ``bootctl`` output
+* If the system is booted through barebox as EFI application (payload),
+  a ``LoaderInfo`` EFI variable with the systemd vendor GUID will
+  be set to the version string. Under Linux, the string is shown in
+  ``bootctl`` output
 
 Query without booting
 ^^^^^^^^^^^^^^^^^^^^^
-- 
2.39.5

Re: [PATCH 1/2] Documentation: user: versioning: fix formatting

[Sascha Hauer]

On Thu, 24 Apr 2025 13:06:30 +0200, Ahmad Fatoum wrote:
> Apparently, Sphinx is space sensitive in literal ``blocks`` and
> currently interprets <space>`` literally and doesn't end the literal
> then.
> 
> 

Applied, thanks!

[1/2] Documentation: user: versioning: fix formatting
      https://git.pengutronix.de/cgit/barebox/commit/?id=c5fdeecb95ab (link may not be stable)
[2/2] Documentation: user: versioning: reduce indentation
      https://git.pengutronix.de/cgit/barebox/commit/?id=fe58b1f7d24e (link may not be stable)

Best regards,
-- 
Sascha Hauer <s.hauer@pengutronix.de>