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

Heinrich Schuchardt xypron.glpk at gmx.de
Tue Jul 10 09:54:02 UTC 2018


On 07/10/2018 08:40 AM, 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.
> 

Hello Mario,

in general I am fine with the conversion.

Unfortunately your patch is not applicable to efi-next.

Applying: doc: Replace DocBook with sphinx-based docs
error: patch failed: lib/efi_loader/efi_boottime.c:2373
error: lib/efi_loader/efi_boottime.c: patch does not apply
Patch failed at 0001 doc: Replace DocBook with sphinx-based docs

Please, separate the lib/efi_loader/* related changes from the rest so
that they can be merged separately. The EFI part should be based on the
efi-next tree of https://github.com/agraf/u-boot.

Please, copy
https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt
into our doc tree as a reference.

Best regards

Heinrich

> Signed-off-by: Mario Six <mario.six at gdsys.cc>
> ---



More information about the U-Boot mailing list