Re: [PATCH 2/2] perf: enable man pages for 'help' functionality

[Joshua G Lock <joshua.g.lock@linux.intel.com>]

[-- Attachment #1: Type: text/plain, Size: 1329 bytes --]

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

[-- Attachment #2: Type: text/html, Size: 1741 bytes --]