From mboxrd@z Thu Jan 1 00:00:00 1970 From: Albert ARIBAUD Date: Thu, 4 Oct 2012 12:07:22 +0200 Subject: [U-Boot] [PATCH 1/4 V2] doc: kerneldoc: Implant DocBook from Linux kernel In-Reply-To: <1348886584-8277-1-git-send-email-marex@denx.de> References: <1348882394-20629-2-git-send-email-marex@denx.de> <1348886584-8277-1-git-send-email-marex@denx.de> Message-ID: <20121004120722.0a8609a3@lilith> List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: u-boot@lists.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 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.