From: William Hubbs <williamh@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Cc: mgorny@gentoo.org
Subject: Re: [gentoo-dev] [PATCH 1/3] go-module.eclass: introduce new eclass to handle go modules
Date: Thu, 12 Sep 2019 11:39:54 -0500 [thread overview]
Message-ID: <20190912163954.GA24121@whubbs1.dev.av1.gaikai.org> (raw)
In-Reply-To: <06381929-4520-4284-B868-EB83D5AE3D6B@gentoo.org>
[-- Attachment #1: Type: text/plain, Size: 8648 bytes --]
On Thu, Sep 12, 2019 at 05:39:42AM +0000, Michał Górny wrote:
> Dnia September 11, 2019 11:11:15 PM UTC, William Hubbs <williamh@gentoo.org> napisał(a):
> >On Wed, Sep 11, 2019 at 07:47:04PM +0000, Michał Górny wrote:
> >> Dnia September 11, 2019 7:40:41 PM UTC, William Hubbs
> ><williamh@gentoo.org> napisał(a):
> >> >On Wed, Sep 11, 2019 at 08:31:16PM +0200, Michał Górny wrote:
> >> >> On Wed, 2019-09-11 at 13:22 -0500, William Hubbs wrote:
> >> >> > On Wed, Sep 11, 2019 at 07:38:17PM +0200, Michał Górny wrote:
> >> >> > > On Wed, 2019-09-11 at 12:21 -0500, William Hubbs wrote:
> >> >> > > > Copyright: Sony Interactive Entertainment Inc.
> >> >> > > > Signed-off-by: William Hubbs <williamh@gentoo.org>
> >> >> > > > ---
> >> >> > > > eclass/go-module.eclass | 76
> >> >+++++++++++++++++++++++++++++++++++++++++
> >> >> > > > 1 file changed, 76 insertions(+)
> >> >> > > > create mode 100644 eclass/go-module.eclass
> >> >> > > >
> >> >> > > > diff --git a/eclass/go-module.eclass
> >b/eclass/go-module.eclass
> >> >> > > > new file mode 100644
> >> >> > > > index 00000000000..7009fcd3beb
> >> >> > > > --- /dev/null
> >> >> > > > +++ b/eclass/go-module.eclass
> >> >> > > > @@ -0,0 +1,76 @@
> >> >> > > > +# Copyright 1999-2015 Gentoo Foundation
> >> >> > >
> >> >> > > You need to replace your calendar. And copyright holder.
> >> >> >
> >> >> > Sure, I thought I ffixed that.
> >> >> >
> >> >> > > > +# Distributed under the terms of the GNU General Public
> >> >License v2
> >> >> > > > +
> >> >> > > > +# @ECLASS: go-module.eclass
> >> >> > >
> >> >> > > Any reason to change naming from golang-* to go-* now?
> >> >> >
> >> >> > Well, "lang" is sort of redundant, and there will be only one
> >> >eclass, so
> >> >> > I thought I would make things a bit more simple.
> >> >> >
> >> >> > > > +# @MAINTAINER:
> >> >> > > > +# William Hubbs <williamh@gentoo.org>
> >> >> > > > +# @SUPPORTED_EAPIS: 7
> >> >> > > > +# @BLURB: basic eclass for building software written in the
> >go
> >> >> > > > +# programming language that uses go modules.
> >> >> > > > +# @DESCRIPTION:
> >> >> > > > +# This eclass provides a convenience src_prepare() phase
> >and
> >> >some basic
> >> >> > > > +# settings needed for all software written in the go
> >> >programming
> >> >> > > > +# language that uses go modules.
> >> >> > > > +#
> >> >> > > > +# You will know the software you are packaging uses modules
> >> >because
> >> >> > > > +# it will have files named go.sum and go.mod in its
> >top-level
> >> >source
> >> >> > > > +# directory. If it does not have these files, use the
> >golang-*
> >> >eclasses.
> >> >> > > > +#
> >> >> > > > +# If the software you are packaging uses modules, the next
> >> >question is
> >> >> > > > +# whether it has a directory named "vendor" at the
> >top-level
> >> >of the source tree.
> >> >> > > > +#
> >> >> > > > +# If it doesn't, you need to create a tarball of what would
> >be
> >> >in the
> >> >> > > > +# vendor directory and mirror it locally. This is done with
> >> >the
> >> >> > > > +# following commands if upstream is using a git repository:
> >> >> > > > +#
> >> >> > > > +# @CODE:
> >> >> > > > +#
> >> >> > > > +# $ cd /my/clone/of/upstream
> >> >> > > > +# $ git checkout <release>
> >> >> > > > +# $ go mod vendor
> >> >> > > > +# $ tar cvf project-version-vendor.tar.gz vendor
> >> >> > > > +#
> >> >> > > > +# @CODE:
> >> >> > > > +#
> >> >> > > > +# Other than this, all you need to do is inherit this
> >eclass
> >> >then
> >> >> > > > +# make sure the exported src_prepare function is run.
> >> >> > > > +
> >> >> > > > +case ${EAPI:-0} in
> >> >> > > > + 7) ;;
> >> >> > > > + *) die "${ECLASS} API in EAPI ${EAPI} not yet
> >established."
> >> >> > > > +esac
> >> >> > > > +
> >> >> > > > +if [[ -z ${_GO_MODULE} ]]; then
> >> >> > > > +
> >> >> > > > +_GO_MODULE=1
> >> >> > > > +
> >> >> > > > +BDEPEND=">=dev-lang/go-1.12"
> >> >> > > > +
> >> >> > > > +# Do not download dependencies from the internet
> >> >> > > > +# make build output verbose by default
> >> >> > > > +export GOFLAGS="-mod=vendor -v -x"
> >> >> > > > +
> >> >> > > > +# Do not complain about CFLAGS etc since go projects do not
> >> >use them.
> >> >> > > > +QA_FLAGS_IGNORED='.*'
> >> >> > > > +
> >> >> > > > +# Upstream does not support stripping go packages
> >> >> > > > +RESTRICT="strip"
> >> >> > > > +
> >> >> > > > +EXPORT_FUNCTIONS src_prepare
> >> >> > >
> >> >> > > Don't you need to inherit some other eclass to make it build?
> >> >> >
> >> >> > The primary reason for all of the golang-* eclasses was the
> >GOPATH
> >> >> > variable, which is not relevant when you are using modules.
> >> >> >
> >> >> > I can look at adding a src_compile to this eclass, but I haven't
> >> >thought
> >> >> > about what it would contain yet.
> >> >> >
> >> >> > > > +
> >> >> > > > +# @FUNCTION: go-module_src_prepare
> >> >> > > > +# @DESCRIPTION:
> >> >> > > > +# Run a default src_prepare then move our provided vendor
> >> >directory to
> >> >> > > > +# the appropriate spot if upstream doesn't provide a vendor
> >> >directory.
> >> >> > > > +go-module_src_prepare() {
> >> >> > > > + default
> >> >> > > > + # Use the upstream provided vendor directory if it exists.
> >> >> > > > + [[ -d vendor ]] && return
> >> >> > > > + # If we are not providing a mirror of a vendor directory
> >we
> >> >created
> >> >> > > > + # manually, return since there may be nothing to vendor.
> >> >> > > > + [[ ! -d ../vendor ]] && return
> >> >> > > > + # At this point, we know we are providing a vendor mirror.
> >> >> > > > + mv ../vendor . || die "Unable to move ../vendor directory"
> >> >> > >
> >> >> > > Wouldn't it be much simpler to create appropriate directory
> >> >structure
> >> >> > > in the tarball? Then you wouldn't need a new eclass at all.
> >> >> >
> >> >> > You would definitely need an eclass (see the settings and
> >> >dependencies).
> >> >> >
> >> >> > Take a look at the differences in the spire and hub ebuilds in
> >this
> >> >> > series. I'm not sure what you mean by adding the directory
> >> >structure to
> >> >> > the tarball? I guess you could add something to the vendor
> >tarball
> >> >when
> >> >> > you create it.
> >> >>
> >> >> I mean packing it as 'spire-1.2.3/vendor' or whatever the package
> >> >> directory is, so that it extracts correctly instead of making a
> >> >tarball
> >> >> that needs to be moved afterwards.
> >> >
> >> >That would clobber the upstream provided vendor directory and that's
> >> >what I want to avoid with the first test in src_prepare.
> >>
> >> If upstream already includes vendored modules, why would you create
> >your own tarball in the first place?
> >
> >You are right, and currently I quietly ignore your vendor tarball if
> >upstream
> >vendors the dependencies also. I could change this to generate a
> >warning
> >or die and force you to fix the ebuild, but that would not be possible
> >if I follow your suggestion because I would not be able to tell whether
> >the vendored dependencies came from us or upstream.
>
> Why would anyone create a vendor tarball if things work without it? That makes no sense. Also adding unused archives to SRC_URI is a QA violation.
All the more reason to not have the vendor tarball overwrite the vendor
directory upstream. I will show you when I update the eclass.
>
> >
> >Also, another concern about your suggestion is the --transform switch
> >that would have to be added to the tar command people use to create
> >the
> >vendor tarball, something like:
> >
> >tar -acvf package-version-vendor.tar.gz
> >--transform='s#^vendor#package-version-vendor#' vendor
> >
> >You suggested that a maintainer could create a new tarball and build on
> >top of it. I guess you mean don't use upstream's tarball if they don't
> >vendor and create my own tarball and add the vendor directory to it.
> >I'm
> >against that option because I don't feel that we should manually
> >tinker
> >with upstream tarballs. That opens a pretty big can of worms imo.
>
> No. I suggested that rather than adding another git clone and checking out a tag (which sooner or later would mean someone forgetting and using master instead), you could unpack the same archive you're going to use in the ebuild.
Ok, I am really not following you, so let's talk about this in the
context of an example.
Look at app-misc/spire and tell me how you would do it differently.
William
[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 195 bytes --]
next prev parent reply other threads:[~2019-09-12 16:40 UTC|newest]
Thread overview: 63+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-11 17:21 [gentoo-dev] [PATCH 0/3] add eclass to handle go modules William Hubbs
2019-09-11 17:21 ` [gentoo-dev] [PATCH 1/3] go-module.eclass: introduce new " William Hubbs
2019-09-11 17:38 ` Michał Górny
2019-09-11 18:22 ` William Hubbs
2019-09-11 18:31 ` Michał Górny
2019-09-11 19:40 ` William Hubbs
2019-09-11 19:47 ` Michał Górny
2019-09-11 23:11 ` William Hubbs
2019-09-12 5:39 ` Michał Górny
2019-09-12 16:39 ` William Hubbs [this message]
2019-09-12 17:03 ` Michał Górny
2019-09-12 20:16 ` Kent Fredric
2019-09-12 21:10 ` Michał Górny
2019-09-11 23:31 ` Alec Warner
2019-09-12 0:05 ` William Hubbs
2019-09-12 0:28 ` Alec Warner
2019-09-12 15:36 ` William Hubbs
2019-09-12 20:20 ` Kent Fredric
2019-09-12 20:38 ` Alec Warner
2019-09-12 21:12 ` Michał Górny
2019-09-12 22:01 ` Alec Warner
2019-09-13 9:13 ` Kent Fredric
2019-09-11 17:21 ` [gentoo-dev] [PATCH 2/3] app-misc/spire: migrate to go-module.eclass William Hubbs
2019-09-11 17:21 ` [gentoo-dev] [PATCH 3/3] dev-vcs/hub: " William Hubbs
2019-09-11 17:39 ` Michael Orlitzky
2019-09-11 17:47 ` William Hubbs
2019-09-11 17:48 ` Michael Orlitzky
2019-09-11 19:15 ` Kent Fredric
2019-09-11 19:26 ` William Hubbs
2019-09-11 23:34 ` Alec Warner
2019-09-11 23:48 ` William Hubbs
2019-09-12 0:05 ` Alec Warner
2019-09-12 15:46 ` William Hubbs
2019-09-12 16:14 ` Michael Orlitzky
2019-09-12 16:42 ` Alec Warner
2019-09-12 16:52 ` Michael Orlitzky
2019-09-12 16:55 ` Mike Gilbert
2019-09-12 17:05 ` Michael Orlitzky
2019-09-12 17:43 ` Mike Gilbert
2019-09-12 21:11 ` Michael Orlitzky
2019-09-12 21:23 ` Mike Gilbert
2019-09-13 0:14 ` Michael Orlitzky
2019-09-13 1:56 ` Alec Warner
2019-09-13 2:16 ` Alec Warner
2019-09-13 3:13 ` Mike Gilbert
2019-09-13 12:11 ` Michael Orlitzky
2019-09-12 17:45 ` Alec Warner
2019-09-12 21:58 ` Michael Orlitzky
2019-09-13 9:19 ` Kent Fredric
2019-09-13 12:29 ` Michael Orlitzky
2019-09-13 20:17 ` Patrick McLean
2019-09-13 23:44 ` Michael Orlitzky
2019-09-14 0:22 ` Patrick McLean
2019-09-14 17:06 ` Alec Warner
2019-09-14 22:37 ` Michael Orlitzky
2019-09-16 7:54 ` Kent Fredric
2019-09-14 6:52 ` Ulrich Mueller
2019-09-13 16:50 ` Michael Orlitzky
2019-09-13 20:52 ` Patrick McLean
2019-09-16 8:11 ` Kent Fredric
2019-09-12 20:10 ` Kent Fredric
2019-09-12 17:31 ` Michał Górny
2019-09-12 16:46 ` Alec Warner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190912163954.GA24121@whubbs1.dev.av1.gaikai.org \
--to=williamh@gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
--cc=mgorny@gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox