From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by mail.openembedded.org (Postfix) with ESMTP id EB2E165CBB for ; Tue, 2 Aug 2016 20:06:43 +0000 (UTC) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga101.jf.intel.com with ESMTP; 02 Aug 2016 13:06:31 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.28,462,1464678000"; d="scan'208,217";a="1018477800" Received: from jlock-mobl1.ger.corp.intel.com ([10.252.8.236]) by fmsmga001.fm.intel.com with ESMTP; 02 Aug 2016 13:06:30 -0700 Message-ID: <1470168389.2984.24.camel@linux.intel.com> From: Joshua G Lock To: "Burton, Ross" , Dengke Du Date: Tue, 02 Aug 2016 21:06:29 +0100 In-Reply-To: References: <63d457eb9aeb264ae65e31c1e78f8024609a38c3.1469595557.git.dengke.du@windriver.com> X-Mailer: Evolution 3.20.4 (3.20.4-1.fc24) Mime-Version: 1.0 Cc: OE-core Subject: Re: [PATCH 2/2] perf: enable man pages for 'help' functionality X-BeenThere: openembedded-core@lists.openembedded.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: Patches and discussions about the oe-core layer List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 02 Aug 2016 20:06:46 -0000 Content-Type: multipart/alternative; boundary="=-PG2Qk/wZMwniuGQwcsEv" --=-PG2Qk/wZMwniuGQwcsEv Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit On Tue, 2016-08-02 at 17:56 +0100, Burton, Ross wrote: > Hi, > > > On 27 July 2016 at 06:02, Dengke Du wrote: > > > > When using 'perf help ', it can't find 'man' command and pages for > > perf. > > > > > > The perf man pages depends on the xmlto-native and asciidoc-native, so we just > > > > > > need to add the two packages to the DEPENDS variable and add 'man'to > > > > RDEPENDS_perf-doc. > > > > > > > Whilst I like the idea of supporting more documentation, and have long wanted to integrate doxygen/gtk-doc/etc into Yocto for building SDKs with API documentation, I'm not sure we should be making random packages depend on tooling to always generate documentation. > > > > > > > What do people think of a distro feature / global environment variable for "recipe should build the documentation"?  For perf this would mean adding asciidoc so it can build the man pages, for GLib it would mean depending on gtk-doc so the API docs can be generated, and so on.  But if they're not needed then they can be disabled to improve build speeds. > > I like the idea. I've had a similar one in mind for a while now as it would be a nice feature to be able to provide the documentation for an image as an output of the system. Regards, Joshua --=-PG2Qk/wZMwniuGQwcsEv Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: 7bit
On Tue, 2016-08-02 at 17:56 +0100, Burton, Ross wrote:
Hi,

On 27 July 2016 at 06:02, Dengke Du <dengke.du@windriver.com> wrote:
When using 'perf help <subcommand>', it can't find 'man' command and pages for
perf.
The perf man pages depends on the xmlto-native and asciidoc-native, so we just
need to add the two packages to the DEPENDS variable and add 'man'to
RDEPENDS_perf-doc.


Whilst I like the idea of supporting more documentation, and have long wanted to integrate doxygen/gtk-doc/etc into Yocto for building SDKs with API documentation, I'm not sure we should be making random packages depend on tooling to always generate documentation.

What do people think of a distro feature / global environment variable for "recipe should build the documentation"?  For perf this would mean adding asciidoc so it can build the man pages, for GLib it would mean depending on gtk-doc so the API docs can be generated, and so on.  But if they're not needed then they can be disabled to improve build speeds.

I like the idea. I've had a similar one in mind for a while now as it would be a nice feature to be able to provide the documentation for an image as an output of the system.

Regards,

Joshua
--=-PG2Qk/wZMwniuGQwcsEv--