mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
From: Robert Schwebel <r.schwebel@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Robert Schwebel <r.schwebel@pengutronix.de>
Subject: [ptxdist] [PATCH 1/4] Documentation: avoid "Title underline too short" warnings
Date: Mon, 12 Jun 2017 21:23:21 +0200	[thread overview]
Message-ID: <20170612192324.19287-1-r.schwebel@pengutronix.de> (raw)

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

             reply	other threads:[~2017-06-12 19:23 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-12 19:23 Robert Schwebel [this message]
2017-06-12 19:23 ` [ptxdist] [PATCH 2/4] " Robert Schwebel
2017-06-12 19:23 ` [ptxdist] [PATCH 3/4] Documentation: avoid warning for unparsable make syntax Robert Schwebel
2017-06-12 19:23 ` [ptxdist] [PATCH 4/4] " Robert Schwebel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170612192324.19287-1-r.schwebel@pengutronix.de \
    --to=r.schwebel@pengutronix.de \
    --cc=ptxdist@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox