From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id E609F138334 for ; Fri, 24 Aug 2018 20:07:01 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 67474E094F; Fri, 24 Aug 2018 20:06:56 +0000 (UTC) Received: from smtp.gentoo.org (dev.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id F3312E08F1 for ; Fri, 24 Aug 2018 20:06:55 +0000 (UTC) Received: from [192.168.2.51] (62.65.228.137.cable.starman.ee [62.65.228.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: leio) by smtp.gentoo.org (Postfix) with ESMTPSA id 37635335C8C for ; Fri, 24 Aug 2018 20:06:53 +0000 (UTC) Message-ID: <1535141206.6451.19.camel@gentoo.org> Subject: [gentoo-dev] [RFC] New global USE flag: gtk-doc From: Mart Raudsepp To: gentoo-dev@lists.gentoo.org Date: Fri, 24 Aug 2018 23:06:46 +0300 Content-Type: multipart/signed; micalg="pgp-sha512"; protocol="application/pgp-signature"; boundary="=-9dgYmXfzPlZroDVTtSyM" X-Mailer: Evolution 3.24.6 Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org Mime-Version: 1.0 X-Archives-Salt: eb8ecd9f-e8ac-4e20-af9f-3c0a0106c335 X-Archives-Hash: f399ebe56c25ab895eb36a236747d76e --=-9dgYmXfzPlZroDVTtSyM Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable USE=3Ddoc has a very overloaded meaning. Meson doesn't ship pre-generated gtk-docs like autotools did, thus developers writing GLib/GTK+ apps may want to keep them around, as libraries move from autotools to meson. gtk-doc is integrated into various IDEs and standalone devhelp viewer, giving a concrete case when one might want to globally enable this (if using those IDEs until they don't have online gtk-doc support that's still in the works, offline developer docs, or matching system versions docs on purpose). Per-package USE=3Ddoc is rather inconvenient to manage. Suggested description for global gtk-doc USE: Build and install gtk-doc based developer documentation Longer version idea: Build and install gtk-doc based developer documentation for dev- util/devhelp, IDE and offline use As the "Build" in the description suggests, this is only for when a generation is needed. In practice this means that it shouldn't be used for autotools based builds from tarballs, where the gtk-doc is already shipped - for those you just want a dev-util/gtk-doc-am build dep, which will make gtkdoc-rebase available that the standard gtk-doc autotools rules call to make the pre-generated docs pretty much equal to what you'd get from regenerating (mainly local offline links). In those aforementioned autotools cases, it's often questionable to have a USE flag (doc) at all for this when using proper tarballs. Most GNOME libraries have converted to using meson, thus building them is necessary to keep local developer docs available and thus keep IDE integration useful. Just always building gtk-doc would be distasteful to some, hence this global USE flag proposal. There will be dozens of consumers as I bump libraries for GNOME 3.26 and even more so 3.28 and 3.30 soon enough afterwards. Some are already there (including some not from GNOME), which currently use USE=3Ddoc for this. Instead of supporting disted tarballs with meson, they plan to do aforementioned online docs support for the API docs integrations, but I haven't heard about any progress on that, plus offline use use case will remain anyways. Mart --=-9dgYmXfzPlZroDVTtSyM Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQKTBAABCgB9FiEEUdZn9pOq0mlNjRvdEKbJ+k9JlgYFAluAZVZfFIAAAAAALgAo aXNzdWVyLWZwckBub3RhdGlvbnMub3BlbnBncC5maWZ0aGhvcnNlbWFuLm5ldDUx RDY2N0Y2OTNBQUQyNjk0RDhEMUJERDEwQTZDOUZBNEY0OTk2MDYACgkQEKbJ+k9J lgZjwhAAojRv0rAz2mnu5q/X5c5Ou/qE3JeqoixFlH7+RQtgMntUS6DkzJ4V4bfs WjbMxxKKbRPPV468bGdMfUDDiFOkuR8HrDOPjMmb2+x1Bk4Spu0e41M1LW81LMK7 KewsN2N/0Rtw7V8CMZG5BgL11HKs2oq4Bgj6kWhN3UUv0ZdLyNSE1F5CgE/ZT/JK 66YCXcW9CFh8n0BBP6/b55VbV/FVrfvwRNU30e7YGlW1RY6F53nSvbOBDcU6MoPB 6p1m6zahWuVZNSWiY/m8mr03HoqDbhmrBONRpNrBvzixwsvBTY1XyrT7CuA0dtsP shl9HgNcneJ9c4Fqe/F5OfH+Z7/yPCnaFnveGitGvsmv4dTcYfMOJp56oQSiLstZ YmDd13fPI8mxDRpV0LPkzF3cBiIftxu68+MQXttyC7/k6XiqHE3u00yagVRZBXOh a81NXmEzqP3snO8XOP34B3Xh7WyWJ+gTjaIkJOdryDQxqQYu6K8UmjpR/Un6iRwS 3XAUlSOv2R1H5FlCUkfwcxy4QraI8ctufuxZHUVANHm4NXQhbYVSrG++UKWfwv0U JF4UTlsFFSms3X8kcVrpcu28AD+bCdLK1m5g5oC08vDdeDQhJpmZ6mklUT6gh/mL vXTeBpQnJ4N5Nk+6zs8JvLHCYmc2A8ZVaCI2xZY77EQ+URDQlf0= =0yrH -----END PGP SIGNATURE----- --=-9dgYmXfzPlZroDVTtSyM--