mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Roland Hieber <r.hieber@pengutronix.de>
To: barebox@lists.infradead.org
Cc: Roland Hieber <r.hieber@pengutronix.de>
Subject: [PATCH 1/2] Documentation: don't highlight literal blocks as shell script
Date: Wed, 25 Jul 2018 16:18:10 +0200	[thread overview]
Message-ID: <20180725141811.25588-1-r.hieber@pengutronix.de> (raw)

There are multiple cases in the documentation where literal blocks are
used for literal, preformatted text. Although it is possible to use
`.. code-block: none` in these cases instead of literal `::` blocks,
follow the principle of least surprise and don't apply any syntax
highlighting at all for literal blocks.

Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
---
 Documentation/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index dbd4a80caa..ec6ec0470b 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -259,4 +259,4 @@ texinfo_documents = [
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
-highlight_language = 'sh'
+highlight_language = 'none'
-- 
2.18.0


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

             reply	other threads:[~2018-07-25 14:18 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-25 14:18 Roland Hieber [this message]
2018-07-25 14:18 ` [PATCH 2/2] Documentation: fix code block and literal block highlighting Roland Hieber
2018-08-08  7:00   ` Sascha Hauer
2018-08-09 12:01     ` Roland Hieber
2018-08-09 22:22   ` [PATCH v2 " Roland Hieber
2018-08-10  6:41     ` Sascha Hauer

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=20180725141811.25588-1-r.hieber@pengutronix.de \
    --to=r.hieber@pengutronix.de \
    --cc=barebox@lists.infradead.org \
    /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