From: Albert ARIBAUD <albert.u.boot@aribaud.net>
To: u-boot@lists.denx.de
Subject: [U-Boot] [PATCH 1/4 V2] doc: kerneldoc: Implant DocBook from Linux kernel
Date: Thu, 4 Oct 2012 12:07:22 +0200 [thread overview]
Message-ID: <20121004120722.0a8609a3@lilith> (raw)
In-Reply-To: <1348886584-8277-1-git-send-email-marex@denx.de>
Hi Marek,
Comments based on the assumption that we want to sync with the Linux
tools.
General comment/hypothetical question: would it not be simpler to patch
the existing Linux tools in-place so that we can use them on the U-Boot
tree?
Detailed comments below in this spirit; ignore if suggestion above is
stupid/complicated/plain wrong/other(specify...or not).
On Sat, 29 Sep 2012 04:43:04 +0200, Marek Vasut <marex@denx.de> wrote:
> Pull slightly modified version of Documentation/DocBook, the related perl
> script scripts/kernel-doc and the scripts/docproc.c from Linux kernel and
> implant it into U-Boot. This will allow smooth generation of kerneldoc
> style documentation.
>
> It was necessary to modify the DocBook/Makefile to work with U-Boot build
> system. The changes were only minor though and involved replacing the kbuild
> specific parts.
Is it possible to make replace these changes with an if/then/else
conditional based on an external option? That would make it possible to
try and backmerge them into the Linux version of kerneldoc.
> It was also necessary to replace use of variables like KERNEL_VERSION with
> U_BOOT_VERSION, strings like Linux kernel with U-Boot Bootloader etc. so
> the generated result actually matches.
Maybe make this change more general, i.e. replace KERNEL_VERSION with
PROJECT_VERSION with a default value assuming Linux, make magic
constant strings variables with a linux-friendly default, and make all
those variables overridable from command line? We'd just have to have a
small script to provide the U-Boot-sensible values.
> Finally, it was necessary to adjust docproc.c, since the documentation in
> U-Boot is located in doc/DocBook instead of Documentation/DocBook as is in
> case of the Linux kernel.
Does it not make sense to drop the change above and instead, symlink
doc/ to Documentation/? We could keep the symlink for one release then
switch to a true rename for the release after.
Amicalement,
--
Albert.
next prev parent reply other threads:[~2012-10-04 10:07 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-09-29 1:33 [U-Boot] [PATCH 0/4] Implant kernel-doc from Linux kernel Marek Vasut
2012-09-29 1:33 ` [U-Boot] [PATCH 1/4] doc: kerneldoc: Implant DocBook " Marek Vasut
2012-09-29 2:43 ` [U-Boot] [PATCH 1/4 V2] " Marek Vasut
2012-10-04 10:07 ` Albert ARIBAUD [this message]
2012-10-05 0:28 ` Marek Vasut
2012-10-05 0:35 ` Graeme Russ
2012-10-05 0:45 ` Marek Vasut
2012-10-05 18:55 ` Albert ARIBAUD
2012-10-06 23:06 ` Marek Vasut
2012-09-29 1:33 ` [U-Boot] [PATCH 2/4] doc: kerneldoc: Add nicer CSS stylesheet for HTML docs Marek Vasut
2012-09-29 1:33 ` [U-Boot] [PATCH 3/4] doc: kerneldoc: Implement "Example" section handling Marek Vasut
2012-09-29 1:33 ` [U-Boot] [PATCH 4/4] doc: kerneldoc: tmpl: Implement template for LG-arrays Marek Vasut
2012-09-30 0:21 ` [U-Boot] [PATCH 0/4 V2] Implant kernel-doc from Linux kernel Marek Vasut
2012-09-30 0:21 ` [U-Boot] [PATCH 1/4] doc: kerneldoc: Implant DocBook " Marek Vasut
2012-09-30 0:21 ` [U-Boot] [PATCH 2/4] doc: kerneldoc: Add nicer CSS stylesheet for HTML docs Marek Vasut
2012-09-30 0:21 ` [U-Boot] [PATCH 3/4] doc: kerneldoc: Implement "Example" section handling Marek Vasut
2012-09-30 0:21 ` [U-Boot] [PATCH 4/4] doc: kerneldoc: tmpl: Implement template for LG-arrays Marek Vasut
2012-10-02 18:28 ` [U-Boot] [PATCH 0/4 V2] Implant kernel-doc from Linux kernel Tom Rini
2012-10-06 23:26 ` Marek Vasut
2012-10-08 15:38 ` Tom Rini
2012-10-08 15:54 ` Marek Vasut
2012-10-09 22:35 ` Tom Rini
2012-10-09 22:37 ` Marek Vasut
2012-10-09 22:51 ` Tom Rini
2012-10-07 0:04 ` [U-Boot] [PATCH 1/4 V3] kerneldoc: Implant DocBook " Marek Vasut
2012-10-07 0:04 ` [U-Boot] [PATCH 2/4 V3] kerneldoc: Add nicer CSS stylesheet for HTML docs Marek Vasut
2012-10-07 0:05 ` [U-Boot] [PATCH 3/4 V3] kerneldoc: Implement "Example" section handling Marek Vasut
2012-10-07 0:05 ` [U-Boot] [PATCH 4/4 V3] kerneldoc: Add myself to the git-mailrc for kerneldoc Marek Vasut
2012-10-22 21:29 ` [U-Boot] [PATCH 1/4 V3] kerneldoc: Implant DocBook from Linux kernel Andy Fleming
2012-10-23 7:30 ` Marek Vasut
2012-10-23 19:56 ` Andy Fleming
2012-10-23 20:58 ` Tom Rini
2012-10-23 21:03 ` Andy Fleming
2012-10-25 18:50 ` Tom Rini
2012-10-25 19:04 ` Marek Vasut
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=20121004120722.0a8609a3@lilith \
--to=albert.u.boot@aribaud.net \
--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