From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from astoria.ccjclearline.com ([64.235.106.9]) by bombadil.infradead.org with esmtps (Exim 4.80.1 #2 (Red Hat Linux)) id 1X2PMp-0004vS-4t for barebox@lists.infradead.org; Wed, 02 Jul 2014 18:34:51 +0000 Date: Wed, 2 Jul 2014 14:34:23 -0400 (EDT) From: "Robert P. J. Day" In-Reply-To: Message-ID: References: <1404297715.5300.44.camel@coredoba.hi.pengutronix.de> MIME-Version: 1.0 List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "barebox" Errors-To: barebox-bounces+u.kleine-koenig=pengutronix.de@lists.infradead.org Subject: Re: generated command references sometimes render a solid blob of text To: Holger Schurig Cc: "barebox@lists.infradead.org" On Wed, 2 Jul 2014, Holger Schurig wrote: > > I don't think that the Kconfig entries need to contain the full command > > documentation. > > Probably not. > > Currently, too many Kconfig options don't have help texts. When I was > new to Barebox, I was puzzled about wether to select an option or not. > Having the complete docs (manually done or auto-generated, doesn't > matter) can be a good help for that. > > It's unfortunate that we have now actually 3 places for the help: via > macros in the source, in the Kconfig, and in the *.rst files. The one > in the source code also have an additional property: that options to > commands can depend on Kconfig entries (e.g. "bootm" depends on > CONFIG_CMD_BOOTM_INITRD, CONFIG_OFTREE and CONFIG_CMD_BOOTM_VERBOSE). > That complicates matters even more. Sigh. gosh, i didn't mean to open quite this can of worms. i'll let those higher up the food chain decide how to deal with this. i have more patches to the user manual coming shortly. rday -- ======================================================================== Robert P. J. Day Ottawa, Ontario, CANADA http://crashcourse.ca Twitter: http://twitter.com/rpjday LinkedIn: http://ca.linkedin.com/in/rpjday ======================================================================== _______________________________________________ barebox mailing list barebox@lists.infradead.org http://lists.infradead.org/mailman/listinfo/barebox