Google Groups no longer supports new Usenet posts or subscriptions. Historical content remains viewable.
Dismiss

[gentoo-dev] proposed USE flag: nodoc

0 views
Skip to first unread message

Drake Wyrm

unread,
Jan 30, 2004, 2:10:04 AM1/30/04
to
Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
(which installs extra documentation), how about a USE flag which inhibits
/any/ documentation. This would be highly handy for trimming down a system
such as a server or router which will never have a warm body sitting in
front of it after everything is installed and configured. What say ye?

--
Batou: Hey, Major... You ever hear of "human rights"?
Kusanagi: I understand the concept, but I've never seen it in action.
--Ghost in the Shell

John Davis

unread,
Jan 30, 2004, 2:10:05 AM1/30/04
to
Drake Wyrm wrote:
> Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
> (which installs extra documentation), how about a USE flag which inhibits
> /any/ documentation. This would be highly handy for trimming down a system
> such as a server or router which will never have a warm body sitting in
> front of it after everything is installed and configured. What say ye?
>
Why not put -doc in USE? If the ebuild is specifying docs to install
using the doc USE, doing the above will negate that effect. All that
needs to be done is make more ebuilds conform to it.

Cheers,
//zhen

--
John Davis
Gentoo Linux Developer
<http://dev.gentoo.org/~zhen>

----
Knowledge can be more terrible than ignorance if you're powerless to
change your world.


--
gento...@gentoo.org mailing list

Donnie Berkholz

unread,
Jan 30, 2004, 2:20:07 AM1/30/04
to
On Fri, 2004-01-30 at 02:05, John Davis wrote:
> Drake Wyrm wrote:
> > Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
> > (which installs extra documentation), how about a USE flag which inhibits
> > /any/ documentation. This would be highly handy for trimming down a system
> > such as a server or router which will never have a warm body sitting in
> > front of it after everything is installed and configured. What say ye?
> >
> Why not put -doc in USE? If the ebuild is specifying docs to install
> using the doc USE, doing the above will negate that effect. All that
> needs to be done is make more ebuilds conform to it.

To my knowledge, the use of the "doc" flag has been primarily
time-consuming doc creation, or that involving large dependences, such
as latex stuff. Not your everyday gzipped README etc.

Many people prefer things the way "-doc" works now, as they get the
necessary docs without all the development stuff, API info, etc.

Donnie

signature.asc

Drake Wyrm

unread,
Jan 30, 2004, 2:30:12 AM1/30/04
to
On Fri, Jan 30, 2004 at 02:05:57AM -0500, in <401A0255...@gentoo.org>, John Davis <zh...@gentoo.org> wrote:
> Drake Wyrm wrote:
> >Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
> >(which installs extra documentation), how about a USE flag which inhibits
> >/any/ documentation. This would be highly handy for trimming down a system
> >such as a server or router which will never have a warm body sitting in
> >front of it after everything is installed and configured. What say ye?
> >
> Why not put -doc in USE? If the ebuild is specifying docs to install
> using the doc USE, doing the above will negate that effect. All that
> needs to be done is make more ebuilds conform to it.

Because nearly every ebuild, even those which USE doc, installs the
normal documentation (e.g. manpages, texinfo, </usr/share/doc/${PVR}/*>)
even with USE=-doc. USE=doc results in *extra* goodies.

Meder Bakirov

unread,
Jan 30, 2004, 2:40:06 AM1/30/04
to
Yes, I second this. It would be superb to have a such option, especially for
server installations.

On Friday 30 January 2004 12:01, Drake Wyrm wrote:
> Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
> (which installs extra documentation), how about a USE flag which inhibits
> /any/ documentation. This would be highly handy for trimming down a system
> such as a server or router which will never have a warm body sitting in
> front of it after everything is installed and configured. What say ye?


--
gento...@gentoo.org mailing list

John Davis

unread,
Jan 30, 2004, 2:40:10 AM1/30/04
to
Drake Wyrm wrote:
> On Fri, Jan 30, 2004 at 02:05:57AM -0500, in <401A0255...@gentoo.org>, John Davis <zh...@gentoo.org> wrote:
>
>>Drake Wyrm wrote:
>>
>>>Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
>>>(which installs extra documentation), how about a USE flag which inhibits
>>>/any/ documentation. This would be highly handy for trimming down a system
>>>such as a server or router which will never have a warm body sitting in
>>>front of it after everything is installed and configured. What say ye?
>>>
>>
>>Why not put -doc in USE? If the ebuild is specifying docs to install
>>using the doc USE, doing the above will negate that effect. All that
>>needs to be done is make more ebuilds conform to it.
>
>
> Because nearly every ebuild, even those which USE doc, installs the
> normal documentation (e.g. manpages, texinfo, </usr/share/doc/${PVR}/*>)
> even with USE=-doc. USE=doc results in *extra* goodies.
>
Then the flag is ambiguous - does it mean all docs or just "special"
docs? I say the best way to go is to just make more ebuilds conform,
perhaps add more documentation about the doc flag to the portage guide.

Ciaran McCreesh

unread,
Jan 30, 2004, 3:00:22 AM1/30/04
to
On Thu, 29 Jan 2004 23:01:57 -0800 Drake Wyrm <wy...@haell.com> wrote:
| Just had an idea for a new USE flag. As a companion to the 'doc' USE
| flag(which installs extra documentation), how about a USE flag which
| inhibits/any/ documentation. This would be highly handy for trimming

| down a system such as a server or router which will never have a warm
| body sitting in front of it after everything is installed and
| configured. What say ye?

As another possibility... How about a nodocs FEATURES instead? This
would prevent *any* documentation from being installed by overriding
dodoc, doman and so on.

--
Ciaran McCreesh
Mail: ciaranm at gentoo.org
Web: http://dev.gentoo.org/~ciaranm

Drake Wyrm

unread,
Jan 30, 2004, 3:40:06 AM1/30/04
to
On Fri, Jan 30, 2004 at 02:34:43AM -0500, in
<401A0913...@gentoo.org>, John Davis <zh...@gentoo.org> wrote:
> Drake Wyrm wrote:
> >On Fri, Jan 30, 2004 at 02:05:57AM -0500, in
> ><401A0255...@gentoo.org>, John Davis <zh...@gentoo.org> wrote:
> >
> >>Drake Wyrm wrote:
> >>
> >>>Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
> >>>(which installs extra documentation), how about a USE flag which inhibits
> >>>/any/ documentation. This would be highly handy for trimming down a
> >>>system
> >>>such as a server or router which will never have a warm body sitting in
> >>>front of it after everything is installed and configured. What say ye?
> >>Why not put -doc in USE? If the ebuild is specifying docs to install
> >>using the doc USE, doing the above will negate that effect. All that
> >>needs to be done is make more ebuilds conform to it.
> >Because nearly every ebuild, even those which USE doc, installs the
> >normal documentation (e.g. manpages, texinfo, </usr/share/doc/${PVR}/*>)
> >even with USE=-doc. USE=doc results in *extra* goodies.
> Then the flag is ambiguous - does it mean all docs or just "special"
> docs? I say the best way to go is to just make more ebuilds conform,
> perhaps add more documentation about the doc flag to the portage guide.

What's ambiguous about it?
doc - Adds extra documentation (API, Javadoc, etc)
-- use.desc

Sven Vermeulen

unread,
Jan 30, 2004, 3:40:09 AM1/30/04
to
On Fri, Jan 30, 2004 at 02:34:43AM -0500, John Davis wrote:
> Then the flag is ambiguous - does it mean all docs or just "special"
> docs? I say the best way to go is to just make more ebuilds conform,
> perhaps add more documentation about the doc flag to the portage guide.

From use.desc:

doc - Adds extra documentation (API, Javadoc, etc)

I don't see the need to go explain every single possible USE flag in a
separate guide if the explanation in use.desc is sufficient. It would only
lead to inconsistencies between docs and use.desc whenever a new USE flag is
generated.

Wkr,
Sven Vermeulen

--
FOSDEM 2004 Free and Open Source Developers European Meeting
21 - 22 februari Brussels, Belgium http://www.fosdem.org

http://www.gentoo.org Documentation & PR sw...@gentoo.org

Drake Wyrm

unread,
Jan 30, 2004, 4:10:03 AM1/30/04
to
On Thu, Jan 29, 2004 at 11:01:57PM -0800, in
<20040130070...@phaenix.haell.com>, Drake Wyrm <wy...@haell.com>
wrote:

> Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
> (which installs extra documentation), how about a USE flag which inhibits
> /any/ documentation. This would be highly handy for trimming down a system
> such as a server or router which will never have a warm body sitting in
> front of it after everything is installed and configured. What say ye?

Hey, look! I'm talking to myself!

After the first few replies, I decided to modify my proposal. Since USE
flags *enable* things when present, it seems inapropos to create one which
*disables* something. Mad props (or something equivalent) to the portage
devs for remaining consistent in this regard. Therefore, I now propose
the USE flag 'stddoc', which will be enabled in the profiles. Emerging
a package with 'USE=-stddoc' will disable the normal documentation.

Mamoru KOMACHI

unread,
Jan 30, 2004, 4:10:08 AM1/30/04
to
I'm not sure when it was added, but at least portage-2.0.49-r21 has

# remove docs
if has nodoc $FEATURES; then
rm -fR ${IMAGE}/usr/share/doc
fi

in dyn_presinst() of ebuild.sh
(grep nodoc/usr/lib/portage/bin/ebuild.sh) noman, noinfo FEATURES are
also supported. However, I cannot find any documentation about this
feature, so I guess it isn't recommended to enable them atm.

--
Mamoru KOMACHI <us...@gentoo.org>


At Fri, 30 Jan 2004 07:53:40 +0000,
Ciaran McCreesh wrote:

--
gento...@gentoo.org mailing list

Paul de Vrieze

unread,
Jan 30, 2004, 4:20:04 AM1/30/04
to
> On Thu, 29 Jan 2004 23:01:57 -0800 Drake Wyrm <wy...@haell.com> wrote: |
Just had an idea for a new USE flag. As a companion to the 'doc' USE |
flag(which installs extra documentation), how about a USE flag which |
inhibits/any/ documentation. This would be highly handy for trimming |
down a system such as a server or router which will never have a warm |
body sitting in front of it after everything is installed and
> | configured. What say ye?
>
> As another possibility... How about a nodocs FEATURES instead? This
would prevent *any* documentation from being installed by overriding
dodoc, doman and so on.

What we want is just a variable in make.conf
INSTALL_MASK="/usr/share/doc /usr/share/man /usr/share/info"

which would mean that files in those dirs will not get installed. In the
meantime you could create a small wrapper for emerge that just removes all
the files from thos directories.

Paul

--
gento...@gentoo.org mailing list

Chris PeBenito

unread,
Jan 30, 2004, 10:50:27 AM1/30/04
to
On Fri, 2004-01-30 at 01:01, Drake Wyrm wrote:
> Just had an idea for a new USE flag. As a companion to the 'doc' USE flag
> (which installs extra documentation), how about a USE flag which inhibits
> /any/ documentation. This would be highly handy for trimming down a system
> such as a server or router which will never have a warm body sitting in
> front of it after everything is installed and configured. What say ye?

Actually nodoc, noman, and noinfo FEATURES crept in a few releases ago,
from the Embedded project. Right now they're really simplistic, and
just rm the respective directory in ${D}/usr/share (see dyn_preinst in
ebuild.sh).

--
Chris PeBenito
<pebe...@gentoo.org>
Developer,
Hardened Gentoo Linux
Embedded Gentoo Linux

Public Key: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0xE6AF9243
Key fingerprint = B0E6 877A 883F A57A 8E6A CB00 BC8E E42D E6AF 9243

signature.asc

Christian Birchinger

unread,
Jan 30, 2004, 11:30:56 AM1/30/04
to
Yes, we talked about INSTALL_MASK some time ago. I wonder why
nodoc and noinfo got added to portage instead of the more
generic and better configurable INSTALL_MASK.

Mamoru KOMACHI

unread,
Jan 28, 2005, 4:50:07 AM1/28/05
to

I'm not sure when it was added, but at least portage-2.0.49-r21 has

# remove docs
if has nodoc $FEATURES; then
rm -fR ${IMAGE}/usr/share/doc
fi

in dyn_presinst() of ebuild.sh (grep nodoc /usr/lib/portage/bin/ebuild.sh)

noman, noinfo FEATURES are also supported. I cannot find any documentation


about this feature, so I guess it isn't recommended to enable them atm.

--
Mamoru KOMACHI <us...@gentoo.org>


At Fri, 30 Jan 2004 07:53:40 +0000,
Ciaran McCreesh wrote:
>

> [1 <text/plain; US-ASCII (7bit)>]

> [2 <application/pgp-signature (7bit)>]
>


--
gento...@gentoo.org mailing list

0 new messages