public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v2 0/6] Better document Sphinx install instructions
Date: Fri, 14 Jul 2017 13:41:15 -0300	[thread overview]
Message-ID: <cover.1500050366.git.mchehab@s-opensource.com> (raw)

The Sphinx build chain is fragile: any upgrades can cause it to break.

That's what happened this week, when I upgraded my machines to
Fedora 26.

So, add a separate chapter at sphinx.rst with Sphinx install instructions,
moving it out of changes.rst. and better name patch 2/6.

v2: improved the text at changes.rst to point to the file name with the
Sphinx build instructions.


Mauro Carvalho Chehab (6):
  changes.rst: Update Sphinx minimal requirements
  docs-rst: move Sphinx install instructions to sphinx.rst
  sphinx.rst: explain the usage of virtual environment
  sphinx.rst: fix unknown reference
  sphinx.rst: describe the install requirements for kfigure
  sphinx.rst: better organize the documentation about PDF build

 Documentation/doc-guide/sphinx.rst | 69 +++++++++++++++++++++++++++++++++++++-
 Documentation/process/changes.rst  | 16 ++-------
 2 files changed, 71 insertions(+), 14 deletions(-)

-- 
2.13.0

             reply	other threads:[~2017-07-14 16:41 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-14 16:41 Mauro Carvalho Chehab [this message]
2017-07-14 16:41 ` [PATCH v2 1/6] changes.rst: Update Sphinx minimal requirements Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 2/6] docs-rst: move Sphinx install instructions to sphinx.rst Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 3/6] sphinx.rst: explain the usage of virtual environment Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 4/6] sphinx.rst: fix unknown reference Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 5/6] sphinx.rst: describe the install requirements for kfigure Mauro Carvalho Chehab
2017-07-14 16:41 ` [PATCH v2 6/6] sphinx.rst: better organize the documentation about PDF build Mauro Carvalho Chehab
2017-07-17 19:40 ` [PATCH v2 0/6] Better document Sphinx install instructions Jonathan Corbet
2017-07-17 21:23   ` Mauro Carvalho Chehab
2017-07-17 21:26     ` Jonathan Corbet
2017-07-17 21:55       ` Mauro Carvalho Chehab

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=cover.1500050366.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@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