[OE-core] [PATCH] sysklogd.inc: add syslogd.8 to ALTERNATIVE_${PN}-doc

[richard.purdie at linuxfoundation.org]

On Thu, 2018-09-27 at 10:19 -0500, Mark Hatle wrote:
> On 9/27/18 4:36 AM, richard.purdie at linuxfoundation.org wrote:
> > On Thu, 2018-09-27 at 13:22 +0800, mingli.yu at windriver.com wrote:
> > > From: Mark Hatle <mark.hatle at windriver.com>
> > > 
> > > Other recipes, such as meta-networking inetutils
> > > may also provide a man page for syslogd.8.
> > > Use the alternatives mechanism to select the man
> > > page to display.
> > > 
> > > This is a partial revert of commit:
> > > 988aad01b20c18a8850db0ad6dc547525d94116c
> > > 
> > > Signed-off-by: Mark Hatle <mark.hatle at windriver.com>
> > > Signed-off-by: Mingli Yu <Mingli.Yu at windriver.com>
> > > ---
> > >  meta/recipes-extended/sysklogd/sysklogd.inc | 6 +++++-
> > >  1 file changed, 5 insertions(+), 1 deletion(-)
> > 
> > I'm not sure I like the sound of this. Why would it provide a man
> > page
> > but not the actual tool itself?
> > 
> > At the very least this needs a better explanation but I'm not sure
> > it
> > sounds correct or is something we want to encourage.
> 
> The syslogd 'tool' is provided by both recipes in their respective 'runtime'
> packages.  In the inet case, it is inetutils-syslogd, which has an appropriate
> RCONFLICTS with the syslogd version.  So only one or the other will be
> installed.  This is the conflict resolution the original commit of
> "988aad01b20c18a8850db0ad6dc547525d94116c" was referring to.
> 
> HOWEVER, both syslogd and inetutils each only have a singular 'doc' package.
> (As do most packages it seems.)  Since this is the case, there and syslogd and
> inetutils (not syslogd part) is requested for this configuration -- AND ---
> doc-pkgs are configured in, you get an error of conflicting files.
> 
> Thus a partial revert of the prior work enabled documentation to be installed
> correctly.
> 
> Now does the documentation match whichever package was installed, maybe not...
> but this isn't a big deal as it turns out, since most syslogd share a common set
> of arguments and those are the things a run-time user would query from the man
> pages.
> 
> The only alternative is to start spliting up the docs into their relevant
> subpackages, as we have the runtime items.  But this then complicates the
> doc-pkgs processing and related...

This makes much more sense with more information. Could someone rewrite
the commit message please?

Cheers,

Richard