Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 9 Dec 2022 09:39:55 -0700
From:      Adam Weinberger <adamw@adamw.org>
To:        Jan Beich <jbeich@freebsd.org>
Cc:        Baptiste Daroussin <bapt@freebsd.org>, ports-committers@freebsd.org,  dev-commits-ports-all@freebsd.org, dev-commits-ports-main@freebsd.org
Subject:   Re: git: 1597e735c46d - main - devel/glib20: rename DOCS into GTKDOC and disable it by default
Message-ID:  <CAP7rwcghpQTbEJy4sAghHxo=8HBPXWv_HGEX701LhwP3WaRPYw@mail.gmail.com>
In-Reply-To: <5yel-3rt5-wny@FreeBSD.org>
References:  <202212090809.2B989uY4030041@gitrepo.freebsd.org> <5yel-3rt5-wny@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
--000000000000aeefa505ef67cef6
Content-Type: text/plain; charset="UTF-8"

On Fri, Dec 9, 2022 at 1:27 AM Jan Beich <jbeich@freebsd.org> wrote:

> Baptiste Daroussin <bapt@FreeBSD.org> writes:
>
> > The branch main has been updated by bapt:
> >
> > URL:
> https://cgit.FreeBSD.org/ports/commit/?id=1597e735c46d62efc9b5b9b74bcdde515e28165a
> >
> > commit 1597e735c46d62efc9b5b9b74bcdde515e28165a
> > Author:     Baptiste Daroussin <bapt@FreeBSD.org>
> > AuthorDate: 2022-12-09 08:07:37 +0000
> > Commit:     Baptiste Daroussin <bapt@FreeBSD.org>
> > CommitDate: 2022-12-09 08:07:37 +0000
> >
> >     devel/glib20: rename DOCS into GTKDOC and disable it by default
> >
> >     Follow the path done for ports depending on doxygen with gtkdoc.
> >     This reduced the number of build dependencies and respects the
> defaults
> >     of the upstream build system.
>
> Reducing build-only dependencies regresses "batteries included" for
> packages.
> One could say it improves/reduces package size but that's only valid
> rationale
> as long as subpackages (D16457) are forever stuck in review.
>

I agree with you about including batteries for user-facing functionality.
But I'll argue that there's a quantifiable difference between including
batteries and including a kitchen sink.

Abusing your metaphor here, glib's docs aren't batteries, nor are they even
manuals. They're schematics, useful for very, very few of our users. The
API docs are only useful for users who'd have no difficulty building a
version that includes them, and their value is easily offset by the comical
time it takes everyone else to build them.

# Adam

-- 
Adam Weinberger
adamw@adamw.org
https://www.adamw.org

--000000000000aeefa505ef67cef6
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div dir=3D"ltr"><div class=3D"gmail_default" style=3D"fon=
t-family:arial,sans-serif">On Fri, Dec 9, 2022 at 1:27 AM Jan Beich &lt;<a =
href=3D"mailto:jbeich@freebsd.org">jbeich@freebsd.org</a>&gt; wrote:</div><=
/div><div class=3D"gmail_quote"><blockquote class=3D"gmail_quote" style=3D"=
margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-lef=
t:1ex">Baptiste Daroussin &lt;bapt@FreeBSD.org&gt; writes:<br>
<br>
&gt; The branch main has been updated by bapt:<br>
&gt;<br>
&gt; URL: <a href=3D"https://cgit.FreeBSD.org/ports/commit/?id=3D1597e735c4=
6d62efc9b5b9b74bcdde515e28165a" rel=3D"noreferrer" target=3D"_blank">https:=
//cgit.FreeBSD.org/ports/commit/?id=3D1597e735c46d62efc9b5b9b74bcdde515e281=
65a</a><br>
&gt;<br>
&gt; commit 1597e735c46d62efc9b5b9b74bcdde515e28165a<br>
&gt; Author:=C2=A0 =C2=A0 =C2=A0Baptiste Daroussin &lt;bapt@FreeBSD.org&gt;=
<br>
&gt; AuthorDate: 2022-12-09 08:07:37 +0000<br>
&gt; Commit:=C2=A0 =C2=A0 =C2=A0Baptiste Daroussin &lt;bapt@FreeBSD.org&gt;=
<br>
&gt; CommitDate: 2022-12-09 08:07:37 +0000<br>
&gt;<br>
&gt;=C2=A0 =C2=A0 =C2=A0devel/glib20: rename DOCS into GTKDOC and disable i=
t by default<br>
&gt;=C2=A0 =C2=A0 =C2=A0<br>
&gt;=C2=A0 =C2=A0 =C2=A0Follow the path done for ports depending on doxygen=
 with gtkdoc.<br>
&gt;=C2=A0 =C2=A0 =C2=A0This reduced the number of build dependencies and r=
espects the defaults<br>
&gt;=C2=A0 =C2=A0 =C2=A0of the upstream build system.<br>
<br>
Reducing build-only dependencies regresses &quot;batteries included&quot; f=
or packages.<br>
One could say it improves/reduces package size but that&#39;s only valid ra=
tionale<br>
as long as subpackages (D16457) are forever stuck in review.<br>
</blockquote></div><div><br></div>I agree with you about including batterie=
s for user-facing functionality. But I&#39;ll argue that there&#39;s a quan=
tifiable difference between including batteries and including a kitchen sin=
k.<div><div style=3D"font-family:arial,sans-serif" class=3D"gmail_default">=
<div><div style=3D"font-family:arial,sans-serif" class=3D"gmail_default"><b=
r></div><div style=3D"font-family:arial,sans-serif" class=3D"gmail_default"=
>Abusing
 your metaphor here, glib&#39;s docs aren&#39;t batteries, nor are they eve=
n=20
manuals. They&#39;re schematics, useful for very, very few of our users. Th=
e API docs are only useful for users who&#39;d have no=20
difficulty building a version that includes them, and their value is=20
easily offset by the comical time it takes everyone else to build them.</di=
v><div style=3D"font-family:arial,sans-serif" class=3D"gmail_default"><br><=
/div></div></div><div style=3D"font-family:arial,sans-serif" class=3D"gmail=
_default"># Adam</div><div style=3D"font-family:arial,sans-serif" class=3D"=
gmail_default"><br></div><div style=3D"font-family:arial,sans-serif" class=
=3D"gmail_default"></div></div>-- <br><div dir=3D"ltr" class=3D"gmail_signa=
ture"><div dir=3D"ltr"><div><div dir=3D"ltr"><div>Adam Weinberger</div><div=
><a href=3D"mailto:adamw@adamw.org" target=3D"_blank">adamw@adamw.org</a></=
div><div><a href=3D"https://www.adamw.org" target=3D"_blank">https://www.ad=
amw.org</a></div></div></div></div></div></div>

--000000000000aeefa505ef67cef6--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAP7rwcghpQTbEJy4sAghHxo=8HBPXWv_HGEX701LhwP3WaRPYw>