[ptxdist] [PATCH 1/4] Documentation: avoid "Title underline too short" warnings

[ptxdist] [PATCH 1/4] Documentation: avoid "Title underline too short" warnings

[Robert Schwebel]

According to the docutils reference manual, the rule for lines is:

  "The underline/overline must be at least as long as the title text."

As some headlines have autogenerated names and we don't know the exact
lengths, make the underlines significantly longer, in order to make the
warning go away.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 doc/environment.rst   | 2 +-
 doc/user_adapting.inc | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/environment.rst b/doc/environment.rst
index ad03a3dfc..9fd89c433 100644
--- a/doc/environment.rst
+++ b/doc/environment.rst
@@ -496,7 +496,7 @@ use the *toolchain* parameter to define the toolchain to be used on a
 per project base.
 
 Building the OSELAS.Toolchain for |ptxdistBSPName|
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Do the following steps in your own home directory ($HOME). The final
 OSELAS.Toolchain gets installed to ``opt/``, but must **never** be
diff --git a/doc/user_adapting.inc b/doc/user_adapting.inc
index ed6732305..a0dbb3b49 100644
--- a/doc/user_adapting.inc
+++ b/doc/user_adapting.inc
@@ -1,5 +1,5 @@
 Adapting the |ptxdistBSPName| Project
--------------------------------------
+---------------------------------------------------------------------------------------------------------------------------------------------------------------
 
 Handling a fully prepared PTXdist project is easy. But everything is
 fixed to the settings the developer selected. We now want to adapt the
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH 2/4] Documentation: avoid "Title underline too short" warnings

[Robert Schwebel]

The underline is too sort, adapt.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 doc/ref_manual.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
index 7729c0aed..3fb457daf 100644
--- a/doc/ref_manual.rst
+++ b/doc/ref_manual.rst
@@ -336,7 +336,7 @@ Install Stage
 TBD
 
 Targetinstall Stage
-^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^
 
 TBD
 
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH 3/4] Documentation: avoid warning for unparsable make syntax

[Robert Schwebel]

Make this warning go away, by adding more make syntax:

  ref_manual.rst:959: WARNING: Could not lex literal_block as "make". Highlighting skipped.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 doc/ref_manual.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
index 3fb457daf..91b499c37 100644
--- a/doc/ref_manual.rst
+++ b/doc/ref_manual.rst
@@ -958,9 +958,10 @@ be installed with some other ``install_*`` command before
 
 .. code-block:: make
 
- @$(call install_replace, timezone, /etc/timezone, @TIMEZONE@, \
-        $(PTXCONF_TIMEZONE_LOCALTIME))
-
+   $(STATEDIR)/timezone.targetinstall:
+        ...
+   	@$(call install_replace, timezone, /etc/timezone, @TIMEZONE@, \
+   		$(PTXCONF_TIMEZONE_LOCALTIME))
 
 .. _param_macros:
 
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

[ptxdist] [PATCH 4/4] Documentation: avoid warning for unparsable make syntax

[Robert Schwebel]

These examples are by far no pure make, so remove the syntax
highlighting hint for make, to make this warning go away:

  docs/ref_manual.rst:980: WARNING: Could not lex literal_block as "make".  Highlighting skipped.
  docs/ref_manual.rst:1011: WARNING: Could not lex literal_block as "make". Highlighting skipped.
  docs/ref_manual.rst:1040: WARNING: Could not lex literal_block as "make". Highlighting skipped.

Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
---
 doc/ref_manual.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
index 91b499c37..3013e5ff4 100644
--- a/doc/ref_manual.rst
+++ b/doc/ref_manual.rst
@@ -977,7 +977,7 @@ the string ``enable``, if unset to ``disable`` instead.
 
 Usage:
 
-.. code-block:: make
+.. code-block:: none
 
  --$(call ptx/endis, <variable>)-<parameter>
 
@@ -1008,7 +1008,7 @@ the string ``disable``, if unset to ``enable`` instead.
 
 Usage:
 
-.. code-block:: make
+.. code-block:: none
 
  --$(call ptx/disen, <variable>)-<parameter>
 
@@ -1037,7 +1037,7 @@ the string ``with``, if unset to ``without`` instead.
 
 Usage:
 
-.. code-block:: make
+.. code-block:: none
 
  --$(call ptx/wwo, <variable>)-<parameter>
 
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de