public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Tom Rini <trini@konsulko.com>
To: u-boot@lists.denx.de
Subject: [U-Boot] doc: Replace DocBook with sphinx-based docs
Date: Thu, 26 Jul 2018 13:59:17 -0400	[thread overview]
Message-ID: <20180726175917.GI11755@bill-the-cat> (raw)
In-Reply-To: <VI1PR04MB20789091CABE453F1DEFCBA89A2B0@VI1PR04MB2078.eurprd04.prod.outlook.com>

On Thu, Jul 26, 2018 at 05:58:24PM +0000, York Sun wrote:

> On 07/24/2018 05:44 AM, Tom Rini wrote:
> > On Tue, Jul 10, 2018 at 08:40:17AM +0200, Mario Six wrote:
> > 
> >> The Linux kernel moved to sphinx-based documentation and got rid of the
> >> DocBook based documentation quite a while ago. Hence, the DocBook
> >> documentation for U-Boot should be converted as well.
> >>
> >> To achieve this, import the necessary files from Linux v4.17, and
> >> convert the current DocBook documentation (three files altogether) to
> >> sphinx/reStructuredText.
> >>
> >> For now, all old DocBook documentation was merged into a single
> >> handbook, tentatively named "U-Boot Hacker Manual".
> >>
> >> For some source files, the documentation style was changed to comply
> >> with kernel-doc; no functional changes were applied.
> >>
> >> Signed-off-by: Mario Six <mario.six@gdsys.cc>
> > 
> > Applied to u-boot/master, thanks!
> > 
> 
> Does anyone see this error?
> 
> $ make distclean
> scripts/Makefile.clean:15: doc/DocBook/Makefile: No such file or directory
> make[1]: *** No rule to make target 'doc/DocBook/Makefile'.  Stop.
> Makefile:1610: recipe for target '_clean_doc/DocBook' failed
> make: *** [_clean_doc/DocBook] Error 2

Yeah, sorry, I've pushed a fix for this earlier today.

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180726/8adfb771/attachment.sig>

  reply	other threads:[~2018-07-26 17:59 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-10  6:40 [U-Boot] [PATCH] doc: Replace DocBook with sphinx-based docs Mario Six
2018-07-10  9:54 ` Heinrich Schuchardt
2018-07-24 12:38 ` [U-Boot] " Tom Rini
2018-07-26 17:58   ` York Sun
2018-07-26 17:59     ` Tom Rini [this message]
2018-07-26 18:00     ` York Sun

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=20180726175917.GI11755@bill-the-cat \
    --to=trini@konsulko.com \
    --cc=u-boot@lists.denx.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