[U-Boot] doc: Replace DocBook with sphinx-based docs

Tom Rini trini at konsulko.com
Thu Jul 26 17:59:17 UTC 2018


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 at 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>


More information about the U-Boot mailing list