public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Michał Górny" <mgorny@gentoo.org>
To: Austin English <wizardedit@gentoo.org>
Cc: gentoo-dev@lists.gentoo.org
Subject: Re: [gentoo-dev] Default DOCS for einstalldocs and HACKING file
Date: Wed, 8 Jun 2016 08:39:14 +0200	[thread overview]
Message-ID: <20160608083914.0f8ee7e1.mgorny@gentoo.org> (raw)
In-Reply-To: <57575FEE.70205@gentoo.org>

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

On Tue, 7 Jun 2016 18:59:42 -0500
Austin English <wizardedit@gentoo.org> wrote:

> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA256
> 
> On 06/07/2016 06:19 PM, M. J. Everitt wrote:
> > On 07/06/16 23:50, NP-Hardass wrote:  
> >> From what I've seen, HACKING is a fairly common doc in FOSS projects.
> >> It doesn't seem to have been included in the default DOCS for
> >> einstalldocs in EAPI6.  While going through the MATE packages, I noticed
> >> that we have quite a few packages that include HACKING in DOCS, so I
> >> cannot delete the DOCS array and take advantage of the automagic doc
> >> detection feature of einstalldocs.
> >>
> >> Does anyone know why we omitted this file from the default DOCS?  A
> >> quick grep of the main repo shows ~370 ebuilds with HACKING listed.   Is
> >> this file no longer considered worthy of being included by default in
> >> our installed docs?  If so, looking for advice on whether it is worth
> >> keeping or dropping that file from my packages?
> >>  
> > I made the suggestion a while back in IRC that it would be nice if there
> > was a way to append to the DOCS array in an ebuild, rather than have to
> > override it, and remember the standard list every time, or just lose the
> > extra file(s). Unfortunately I was laughed out of the channel. So,
> > whilst it would probably be something for another EAPI change .. what do
> > readers think of the idea of an EXTRA_DOCS variable or similar method
> > for doing this, for exactly this reason/purpose??
> >
> > MJE  
> 
> Some way to append docfiles would be very welcome IMO.

src_install() {
  default
  dodoc HACKING
}

You're welcome.

-- 
Best regards,
Michał Górny
<http://dev.gentoo.org/~mgorny/>

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 949 bytes --]

  reply	other threads:[~2016-06-08  6:39 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-06-07 22:50 [gentoo-dev] Default DOCS for einstalldocs and HACKING file NP-Hardass
2016-06-07 23:19 ` M. J. Everitt
2016-06-07 23:59   ` Austin English
2016-06-08  6:39     ` Michał Górny [this message]
2016-06-08 20:22     ` Daniel Campbell
2016-06-08  6:40 ` Michał Górny
2016-06-09  4:54   ` NP-Hardass

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20160608083914.0f8ee7e1.mgorny@gentoo.org \
    --to=mgorny@gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    --cc=wizardedit@gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox