Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Wed, May 5, 2021 at 3:16 PM Richard Purdie < richard.pur...@linuxfoundation.org> wrote: > On Wed, 2021-05-05 at 15:07 -0700, Khem Raj wrote: > > On Wed, May 5, 2021 at 2:52 PM Richard Purdie > > wrote: > > > > > > On Wed, 2021-05-05 at 14:28 -0700, Khem Raj wrote: > > > > On Wed, May 5, 2021 at 2:09 PM Richard Purdie > > > > wrote: > > > > > > > > > > On Wed, 2021-05-05 at 20:45 +0200, Alexander Kanavin wrote: > > > > > > On Wed, 5 May 2021 at 20:05, Khem Raj > wrote: > > > > > > > On Wed, May 5, 2021 at 8:20 AM Alexander Kanavin < > alex.kana...@gmail.com> wrote: > > > > > > > > > > > > > > > > This seems to be the gtk-doc successor, and gnome > > > > > > > > projects such as pango and gdk-pixbuf have started > > > > > > > > transitioning to it. > > > > > > > > > > > > > > > > > > > > > > going through > > > > > > > https://gitlab.gnome.org/GNOME/gi-docgen#disclaimer > > > > > > > > > > > > > > it seems that its still under development and not declared > stable, so > > > > > > > I am wary of the churn it will cause. > > > > > > > I would prefer to wait until at least its declared prime time > for > > > > > > > system wide inclusion. > > > > > > > > > > > > > > > > > > > > > > > > > It is only built if you enable api-documentation, and even then > used only > > > > > > in pango and gdk-pixbuf. I'd say it's fairly well contained. > > > > > > > > > > I did also have a quick chat with friends in that community and > their advice > > > > > was that it was ok to switch now FWIW... > > > > > > > > ok, that helps, perhaps they can reflect this assertion in document > above? > > > > but still, depending upon abandoned packages needs to be answered by > > > > upstream IMO before we tread down this path > > > > > > Reading that disclaimer, it seems to be saying they're making it work > for gtk. > > > We're using it in the gtk related components it is being developed for > so I'm > > > not sure there is an issue. What it says not to do is use it for > general non-gtk > > > code. We're not using it outside gtk? > > > > This above says > > > > GI-DocGen is still in development. The recommended use of GI-DocGen is > > to add it as a sub-project to your Meson build system, and vendor it > > when releasing dist archives. > > > > we are trying to use it in system mode and not vendored along with > > packages which need it. Perhaps I am misunderstanding? > > Effectively we are vendoring it since only things with a dependency on it > will see it > and we're only depending on it from things which it is intended for. It > isn't like > we're making it a system wide development tool. I thought vendoring would mean you don’t need the tools that are used but the output is captured like how configure file is pregenerated in autoconf world But I guess we want the updates so as long as we can make progress with upstream on seeing if these dependencies would have some adopters so they can be maintained we should be good > > Cheers, > > Richard > > -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#151372): https://lists.openembedded.org/g/openembedded-core/message/151372 Mute This Topic: https://lists.openembedded.org/mt/82607077/21656 Group Owner: openembedded-core+ow...@lists.openembedded.org Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Wed, 2021-05-05 at 15:07 -0700, Khem Raj wrote: > On Wed, May 5, 2021 at 2:52 PM Richard Purdie > wrote: > > > > On Wed, 2021-05-05 at 14:28 -0700, Khem Raj wrote: > > > On Wed, May 5, 2021 at 2:09 PM Richard Purdie > > > wrote: > > > > > > > > On Wed, 2021-05-05 at 20:45 +0200, Alexander Kanavin wrote: > > > > > On Wed, 5 May 2021 at 20:05, Khem Raj wrote: > > > > > > On Wed, May 5, 2021 at 8:20 AM Alexander Kanavin > > > > > > wrote: > > > > > > > > > > > > > > This seems to be the gtk-doc successor, and gnome > > > > > > > projects such as pango and gdk-pixbuf have started > > > > > > > transitioning to it. > > > > > > > > > > > > > > > > > > > going through > > > > > > https://gitlab.gnome.org/GNOME/gi-docgen#disclaimer > > > > > > > > > > > > it seems that its still under development and not declared stable, > > > > > > so > > > > > > I am wary of the churn it will cause. > > > > > > I would prefer to wait until at least its declared prime time for > > > > > > system wide inclusion. > > > > > > > > > > > > > > > > > > > > > It is only built if you enable api-documentation, and even then used > > > > > only > > > > > in pango and gdk-pixbuf. I'd say it's fairly well contained. > > > > > > > > I did also have a quick chat with friends in that community and their > > > > advice > > > > was that it was ok to switch now FWIW... > > > > > > ok, that helps, perhaps they can reflect this assertion in document above? > > > but still, depending upon abandoned packages needs to be answered by > > > upstream IMO before we tread down this path > > > > Reading that disclaimer, it seems to be saying they're making it work for > > gtk. > > We're using it in the gtk related components it is being developed for so > > I'm > > not sure there is an issue. What it says not to do is use it for general > > non-gtk > > code. We're not using it outside gtk? > > This above says > > GI-DocGen is still in development. The recommended use of GI-DocGen is > to add it as a sub-project to your Meson build system, and vendor it > when releasing dist archives. > > we are trying to use it in system mode and not vendored along with > packages which need it. Perhaps I am misunderstanding? Effectively we are vendoring it since only things with a dependency on it will see it and we're only depending on it from things which it is intended for. It isn't like we're making it a system wide development tool. Cheers, Richard -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#151365): https://lists.openembedded.org/g/openembedded-core/message/151365 Mute This Topic: https://lists.openembedded.org/mt/82607077/21656 Group Owner: openembedded-core+ow...@lists.openembedded.org Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Thu, 6 May 2021 at 00:07, Khem Raj wrote: > > > Reading that disclaimer, it seems to be saying they're making it work > for gtk. > > We're using it in the gtk related components it is being developed for > so I'm > > not sure there is an issue. What it says not to do is use it for general > non-gtk > > code. We're not using it outside gtk? > > This above says > > GI-DocGen is still in development. The recommended use of GI-DocGen is > to add it as a sub-project to your Meson build system, and vendor it > when releasing dist archives. > > we are trying to use it in system mode and not vendored along with > packages which need it. Perhaps I am misunderstanding? > The options are: - do not update pango and gdk-pixbuf - update them but drop api documentation support from them, as they no longer support gtk-doc - update them and enable gi-docgen for them, through a recipe that ensures we have reproducibility and consistency in what version of gi-docgen is being used across consumer recipes. The gi-docgen recipe outputs would only be provided at build time into their sysroots, and won't be used otherwise. It's been tested on the AB, and it works. I think you're inventing a problem here that does not actually exist. Alex -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#151364): https://lists.openembedded.org/g/openembedded-core/message/151364 Mute This Topic: https://lists.openembedded.org/mt/82607077/21656 Group Owner: openembedded-core+ow...@lists.openembedded.org Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Wed, May 5, 2021 at 2:52 PM Richard Purdie wrote: > > On Wed, 2021-05-05 at 14:28 -0700, Khem Raj wrote: > > On Wed, May 5, 2021 at 2:09 PM Richard Purdie > > wrote: > > > > > > On Wed, 2021-05-05 at 20:45 +0200, Alexander Kanavin wrote: > > > > On Wed, 5 May 2021 at 20:05, Khem Raj wrote: > > > > > On Wed, May 5, 2021 at 8:20 AM Alexander Kanavin > > > > > wrote: > > > > > > > > > > > > This seems to be the gtk-doc successor, and gnome > > > > > > projects such as pango and gdk-pixbuf have started > > > > > > transitioning to it. > > > > > > > > > > > > > > > > going through > > > > > https://gitlab.gnome.org/GNOME/gi-docgen#disclaimer > > > > > > > > > > it seems that its still under development and not declared stable, so > > > > > I am wary of the churn it will cause. > > > > > I would prefer to wait until at least its declared prime time for > > > > > system wide inclusion. > > > > > > > > > > > > > > > > > It is only built if you enable api-documentation, and even then used > > > > only > > > > in pango and gdk-pixbuf. I'd say it's fairly well contained. > > > > > > I did also have a quick chat with friends in that community and their > > > advice > > > was that it was ok to switch now FWIW... > > > > ok, that helps, perhaps they can reflect this assertion in document above? > > but still, depending upon abandoned packages needs to be answered by > > upstream IMO before we tread down this path > > Reading that disclaimer, it seems to be saying they're making it work for gtk. > We're using it in the gtk related components it is being developed for so I'm > not sure there is an issue. What it says not to do is use it for general > non-gtk > code. We're not using it outside gtk? This above says GI-DocGen is still in development. The recommended use of GI-DocGen is to add it as a sub-project to your Meson build system, and vendor it when releasing dist archives. we are trying to use it in system mode and not vendored along with packages which need it. Perhaps I am misunderstanding? > > Cheers, > > Richard > -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#151363): https://lists.openembedded.org/g/openembedded-core/message/151363 Mute This Topic: https://lists.openembedded.org/mt/82607077/21656 Group Owner: openembedded-core+ow...@lists.openembedded.org Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Wed, 2021-05-05 at 14:28 -0700, Khem Raj wrote: > On Wed, May 5, 2021 at 2:09 PM Richard Purdie > wrote: > > > > On Wed, 2021-05-05 at 20:45 +0200, Alexander Kanavin wrote: > > > On Wed, 5 May 2021 at 20:05, Khem Raj wrote: > > > > On Wed, May 5, 2021 at 8:20 AM Alexander Kanavin > > > > wrote: > > > > > > > > > > This seems to be the gtk-doc successor, and gnome > > > > > projects such as pango and gdk-pixbuf have started > > > > > transitioning to it. > > > > > > > > > > > > > going through > > > > https://gitlab.gnome.org/GNOME/gi-docgen#disclaimer > > > > > > > > it seems that its still under development and not declared stable, so > > > > I am wary of the churn it will cause. > > > > I would prefer to wait until at least its declared prime time for > > > > system wide inclusion. > > > > > > > > > > > > > It is only built if you enable api-documentation, and even then used only > > > in pango and gdk-pixbuf. I'd say it's fairly well contained. > > > > I did also have a quick chat with friends in that community and their advice > > was that it was ok to switch now FWIW... > > ok, that helps, perhaps they can reflect this assertion in document above? > but still, depending upon abandoned packages needs to be answered by > upstream IMO before we tread down this path Reading that disclaimer, it seems to be saying they're making it work for gtk. We're using it in the gtk related components it is being developed for so I'm not sure there is an issue. What it says not to do is use it for general non-gtk code. We're not using it outside gtk? Cheers, Richard -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#151360): https://lists.openembedded.org/g/openembedded-core/message/151360 Mute This Topic: https://lists.openembedded.org/mt/82607077/21656 Group Owner: openembedded-core+ow...@lists.openembedded.org Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Wed, May 5, 2021 at 2:09 PM Richard Purdie wrote: > > On Wed, 2021-05-05 at 20:45 +0200, Alexander Kanavin wrote: > > On Wed, 5 May 2021 at 20:05, Khem Raj wrote: > > > On Wed, May 5, 2021 at 8:20 AM Alexander Kanavin > > > wrote: > > > > > > > > This seems to be the gtk-doc successor, and gnome > > > > projects such as pango and gdk-pixbuf have started > > > > transitioning to it. > > > > > > > > > > going through > > > https://gitlab.gnome.org/GNOME/gi-docgen#disclaimer > > > > > > it seems that its still under development and not declared stable, so > > > I am wary of the churn it will cause. > > > I would prefer to wait until at least its declared prime time for > > > system wide inclusion. > > > > > > > > > It is only built if you enable api-documentation, and even then used only > > in pango and gdk-pixbuf. I'd say it's fairly well contained. > > I did also have a quick chat with friends in that community and their advice > was that it was ok to switch now FWIW... ok, that helps, perhaps they can reflect this assertion in document above? but still, depending upon abandoned packages needs to be answered by upstream IMO before we tread down this path > > Cheers, > > Richard > -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#151358): https://lists.openembedded.org/g/openembedded-core/message/151358 Mute This Topic: https://lists.openembedded.org/mt/82607077/21656 Group Owner: openembedded-core+ow...@lists.openembedded.org Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Wed, 2021-05-05 at 20:45 +0200, Alexander Kanavin wrote: > On Wed, 5 May 2021 at 20:05, Khem Raj wrote: > > On Wed, May 5, 2021 at 8:20 AM Alexander Kanavin > > wrote: > > > > > > This seems to be the gtk-doc successor, and gnome > > > projects such as pango and gdk-pixbuf have started > > > transitioning to it. > > > > > > > going through > > https://gitlab.gnome.org/GNOME/gi-docgen#disclaimer > > > > it seems that its still under development and not declared stable, so > > I am wary of the churn it will cause. > > I would prefer to wait until at least its declared prime time for > > system wide inclusion. > > > > > It is only built if you enable api-documentation, and even then used only > in pango and gdk-pixbuf. I'd say it's fairly well contained. I did also have a quick chat with friends in that community and their advice was that it was ok to switch now FWIW... Cheers, Richard -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#151356): https://lists.openembedded.org/g/openembedded-core/message/151356 Mute This Topic: https://lists.openembedded.org/mt/82607077/21656 Group Owner: openembedded-core+ow...@lists.openembedded.org Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Wed, 5 May 2021 at 20:05, Khem Raj wrote: > On Wed, May 5, 2021 at 8:20 AM Alexander Kanavin > wrote: > > > > This seems to be the gtk-doc successor, and gnome > > projects such as pango and gdk-pixbuf have started > > transitioning to it. > > > > going through > https://gitlab.gnome.org/GNOME/gi-docgen#disclaimer > > it seems that its still under development and not declared stable, so > I am wary of the churn it will cause. > I would prefer to wait until at least its declared prime time for > system wide inclusion. > It is only built if you enable api-documentation, and even then used only in pango and gdk-pixbuf. I'd say it's fairly well contained. Alex -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#151341): https://lists.openembedded.org/g/openembedded-core/message/151341 Mute This Topic: https://lists.openembedded.org/mt/82607077/21656 Group Owner: openembedded-core+ow...@lists.openembedded.org Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [OE-core] [PATCH 58/61] gi-docgen: add a recipe and class
On Wed, May 5, 2021 at 8:20 AM Alexander Kanavin wrote:
>
> This seems to be the gtk-doc successor, and gnome
> projects such as pango and gdk-pixbuf have started
> transitioning to it.
>
going through
https://gitlab.gnome.org/GNOME/gi-docgen#disclaimer
it seems that its still under development and not declared stable, so
I am wary of the churn it will cause.
I would prefer to wait until at least its declared prime time for
system wide inclusion.
> Signed-off-by: Alexander Kanavin
> ---
> meta/classes/gi-docgen.bbclass| 24 +++
> meta/conf/distro/include/maintainers.inc | 1 +
> meta/recipes-gnome/gi-docgen/gi-docgen_git.bb | 22 +
> 3 files changed, 47 insertions(+)
> create mode 100644 meta/classes/gi-docgen.bbclass
> create mode 100644 meta/recipes-gnome/gi-docgen/gi-docgen_git.bb
>
> diff --git a/meta/classes/gi-docgen.bbclass b/meta/classes/gi-docgen.bbclass
> new file mode 100644
> index 00..5750f7028d
> --- /dev/null
> +++ b/meta/classes/gi-docgen.bbclass
> @@ -0,0 +1,24 @@
> +# gi-docgen is a new gnome documentation generator, which
> +# seems to be a successor to gtk-doc:
> +# https://gitlab.gnome.org/GNOME/gi-docgen
> +
> +# This variable is set to True if api-documentation is in
> +# DISTRO_FEATURES, and False otherwise.
> +GIDOCGEN_ENABLED ?= "${@bb.utils.contains('DISTRO_FEATURES',
> 'api-documentation', 'True', 'False', d)}"
> +# When building native recipes, disable gi-docgen, as it is not necessary,
> +# pulls in additional dependencies, and makes build times longer
> +GIDOCGEN_ENABLED_class-native = "False"
> +GIDOCGEN_ENABLED_class-nativesdk = "False"
> +
> +# meson: default option name to enable/disable gi-docgen. This matches most
> +# projects' configuration. In doubts - check meson_options.txt in project's
> +# source path.
> +GIDOCGEN_MESON_OPTION ?= 'gtk_doc'
> +GIDOCGEN_MESON_ENABLE_FLAG ?= 'true'
> +GIDOCGEN_MESON_DISABLE_FLAG ?= 'false'
> +
> +# Auto enable/disable based on GIDOCGEN_ENABLED
> +EXTRA_OEMESON_prepend =
> "-D${GIDOCGEN_MESON_OPTION}=${@bb.utils.contains('GIDOCGEN_ENABLED', 'True',
> '${GIDOCGEN_MESON_ENABLE_FLAG}', '${GIDOCGEN_MESON_DISABLE_FLAG}', d)} "
> +
> +DEPENDS_append = "${@' gi-docgen-native gi-docgen' if
> d.getVar('GIDOCGEN_ENABLED') == 'True' else ''}"
> +
> diff --git a/meta/conf/distro/include/maintainers.inc
> b/meta/conf/distro/include/maintainers.inc
> index 0c3e3628ba..bfebd68acf 100644
> --- a/meta/conf/distro/include/maintainers.inc
> +++ b/meta/conf/distro/include/maintainers.inc
> @@ -205,6 +205,7 @@ RECIPE_MAINTAINER_pn-gdk-pixbuf = "Ross Burton
> "
> RECIPE_MAINTAINER_pn-gettext = "Robert Yang "
> RECIPE_MAINTAINER_pn-gettext-minimal-native = "Robert Yang
> "
> RECIPE_MAINTAINER_pn-ghostscript = "Hongxu Jia "
> +RECIPE_MAINTAINER_pn-gi-docgen = "Alexander Kanavin "
> RECIPE_MAINTAINER_pn-git = "Robert Yang "
> RECIPE_MAINTAINER_pn-glew = "Anuj Mittal "
> RECIPE_MAINTAINER_pn-glib-2.0 = "Anuj Mittal "
> diff --git a/meta/recipes-gnome/gi-docgen/gi-docgen_git.bb
> b/meta/recipes-gnome/gi-docgen/gi-docgen_git.bb
> new file mode 100644
> index 00..4d779a9bdd
> --- /dev/null
> +++ b/meta/recipes-gnome/gi-docgen/gi-docgen_git.bb
> @@ -0,0 +1,22 @@
> +SUMMARY = "Documentation tool for GObject-based libraries"
> +DESCRIPTION = "GI-DocGen is a document generator for GObject-based
> libraries. GObject is \
> +the base type system of the GNOME project. GI-Docgen reuses the \
> +introspection data generated by GObject-based libraries to generate the API \
> +reference of these libraries, as well as other ancillary documentation."
> +HOMEPAGE = "https://gnome.pages.gitlab.gnome.org/gi-docgen/;
> +
> +LICENSE = "GPLv3+ & Apache-2.0"
> +LIC_FILES_CHKSUM =
> "file://gi-docgen.py;beginline=1;endline=5;md5=2dc0f1f01202478cfe813c0e7f80b326"
> +
> +SRC_URI =
> "git://gitlab.gnome.org/GNOME/gi-docgen.git;protocol=https;branch=main"
> +
> +PV = "2021.5"
> +SRCREV = "7dee859321573f9c843ef7fb136f11142cb6ddf8"
> +
> +S = "${WORKDIR}/git"
> +
> +inherit setuptools3
> +
> +RDEPENDS_${PN} += "python3-asyncio python3-core python3-jinja2 python3-json
> python3-markdown python3-markupsafe python3-pygments python3-toml
> python3-typogrify python3-xml"
> +
> +BBCLASSEXTEND = "native"
> --
> 2.31.1
>
>
>
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#151335):
https://lists.openembedded.org/g/openembedded-core/message/151335
Mute This Topic: https://lists.openembedded.org/mt/82607077/21656
Group Owner: openembedded-core+ow...@lists.openembedded.org
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub
[arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
