[gentoo-dev] Default DOCS for einstalldocs and HACKING file

[gentoo-dev] Default DOCS for einstalldocs and HACKING file

[NP-Hardass]

[-- Attachment #1.1: Type: text/plain, Size: 741 bytes --]

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?

-- 
NP-Hardass


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

Re: [gentoo-dev] Default DOCS for einstalldocs and HACKING file

[M. J. Everitt]

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

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


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

Re: [gentoo-dev] Default DOCS for einstalldocs and HACKING file

[Austin English]

-----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.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCAAGBQJXV1/uAAoJEACzKVe5S/PhQuAP/0OZxgfG5tD9IrBV+8VulPr7
TbVq+XITJ3iNwHIvVtZdW65Us+RGJ+oVSET8EroWhUxMV5udjVsphKQ6kXiV6Uc9
IehRKTBeXnwzzhke853xBvV0WLGxQECj3zqpDfHUpaODeR5IB7zvw3qAnhzzaHYQ
QPKuvHm1l1rRIqeHqXY/6kd8DJrCXY1YsF7P1FwYZznmUUGGC1+bYt70rY1OJ6qG
P/SM/fe8C1BTtXQpFDacE6f76fs5AT9MaC9a3/fr6UAiYlKz7bL7l+kzTjHpwuf/
yQGlL9Xc2Cp3zUoXp3zN0Zf+jhxsPvL/4LVv/BPY4IvNFBGCBzBD7Lqv1ootDlZM
HNBcdZV7opz5T8/nCTN35iA1KHgvTxsWwF/vFjtSbaxF4lnhw3OQSFPz6iILQFnj
Xo/7rjw4y4HFBe5BzYujjvl2dDeXfJpEAr9KaOj4yuUpLB1RBLZ2+/uhkcwl5Tp7
pTKG9yKjKOze43fwXITtD8ALCmR3Jn9haMyku9NLiRDr8hKKvSTDC3xeAHeEMMuN
RG9yDrqhfp/rtU3WKCo6hnJ300YJxRm12ltbSqXJEdaVdv2vLoIKJUfaGmGhAHaz
dHtOHjolLI8jjhRsv4bgSYXbQOSJzU/gy2ZsJsHgGibRiRLloe6z8he9RrjaImZB
N+y8gnQjT8GObWtDmiXn
=gTUn
-----END PGP SIGNATURE-----

Re: [gentoo-dev] Default DOCS for einstalldocs and HACKING file

[Michał Górny]

[-- 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 --]

Re: [gentoo-dev] Default DOCS for einstalldocs and HACKING file

[Michał Górny]

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

On Tue, 7 Jun 2016 18:50:05 -0400
NP-Hardass <NP-Hardass@gentoo.org> 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?

File a Future EAPI bug asking to include it in EAPI 7. I don't see
a reason to omit it by default.

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

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

Re: [gentoo-dev] Default DOCS for einstalldocs and HACKING file

[Daniel Campbell]

[-- Attachment #1.1: Type: text/plain, Size: 1740 bytes --]

On 06/07/2016 04:59 PM, Austin English wrote:
> 
> 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.
> 
> 
Agreed. We can already add on to other arrays or lists, why should DOCS
be any different?
-- 
Daniel Campbell - Gentoo Developer
OpenPGP Key: 0x1EA055D6 @ hkp://keys.gnupg.net
fpr: AE03 9064 AE00 053C 270C  1DE4 6F7A 9091 1EA0 55D6


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

Re: [gentoo-dev] Default DOCS for einstalldocs and HACKING file

[NP-Hardass]

[-- Attachment #1.1: Type: text/plain, Size: 1136 bytes --]

On 06/08/2016 02:40 AM, Michał Górny wrote:
> On Tue, 7 Jun 2016 18:50:05 -0400
> NP-Hardass <NP-Hardass@gentoo.org> 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?
> 
> File a Future EAPI bug asking to include it in EAPI 7. I don't see
> a reason to omit it by default.
> 

Done. Thanks for the suggestion.

https://bugs.gentoo.org/show_bug.cgi?id=585428 in case anyone is interested.
-- 
NP-Hardass


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