Libguestfs - Jun 2020 - Re: nbdkit rust plugin: copyright notices, Cargo workspace, and macro hygiene

On Wed, Jun 17, 2020 at 5:23 AM Richard W.M. Jones <rjones@redhat.com>
wrote:
> I pushed 2 & 3, thanks.
>
> But ...
>
> > From 9fa3e443467e3c06761ec54241327e8daf8701ca Mon Sep 17 00:00:00 2001
> > From: Alan Somers <asomers@gmail.com>
> > Date: Mon, 15 Jun 2020 16:59:53 -0600
> > Subject: [PATCH 1/3] Add a Cargo.toml file to the top-level directory
> >
> > This is necessary for other Rust projects to depend on unrelesed
> > versions of the nbdkit crate.
> > ---
> >  Cargo.toml | 2 ++
> >  1 file changed, 2 insertions(+)
> >  create mode 100644 Cargo.toml
> >
> > diff --git a/Cargo.toml b/Cargo.toml
> > new file mode 100644
> > index 00000000..f50a66b7
> > --- /dev/null
> > +++ b/Cargo.toml
> > @@ -0,0 +1,2 @@
> > +[workspace]
> > +members = ["plugins/rust"]
>
> Is it really absolutely necessary to have this in the top level
> directory of the source tree?
>
> Rich.
>
Turns out it isn't.  It didn't work when I tried it the first time, and
I
thought that this was the reason why.  But it turns out the real reason was
because you had been generating your Cargo.toml file with autotools.
That's no longer the case, after my last patch.  So you don't need the
workspace Cargo.toml file after all.
-Alan

On Wed, Jun 17, 2020 at 08:42:19AM -0600, alan somers
wrote:
> On Wed, Jun 17, 2020 at 5:23 AM Richard W.M. Jones
<rjones@redhat.com>
> wrote:
> 
> > I pushed 2 & 3, thanks.
> >
> > But ...
> >
> > > From 9fa3e443467e3c06761ec54241327e8daf8701ca Mon Sep 17 00:00:00
2001
> > > From: Alan Somers <asomers@gmail.com>
> > > Date: Mon, 15 Jun 2020 16:59:53 -0600
> > > Subject: [PATCH 1/3] Add a Cargo.toml file to the top-level
directory
> > >
> > > This is necessary for other Rust projects to depend on unrelesed
> > > versions of the nbdkit crate.
> > > ---
> > >  Cargo.toml | 2 ++
> > >  1 file changed, 2 insertions(+)
> > >  create mode 100644 Cargo.toml
> > >
> > > diff --git a/Cargo.toml b/Cargo.toml
> > > new file mode 100644
> > > index 00000000..f50a66b7
> > > --- /dev/null
> > > +++ b/Cargo.toml
> > > @@ -0,0 +1,2 @@
> > > +[workspace]
> > > +members = ["plugins/rust"]
> >
> > Is it really absolutely necessary to have this in the top level
> > directory of the source tree?
> >
> > Rich.
> >
> 
> Turns out it isn't.  It didn't work when I tried it the first time,
and I
> thought that this was the reason why.  But it turns out the real reason was
> because you had been generating your Cargo.toml file with autotools.
> That's no longer the case, after my last patch.  So you don't need
the
> workspace Cargo.toml file after all.
OK, thanks for checking that.

If we did need to generate Cargo.toml again in future (eg. to include
the nbdkit version number) then we might include the generated file
into git, if that helps.  In other projects we have included selected
generated files in git for various reasons.

Rich.

-- 
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
Read my programming and virtualization blog: http://rwmj.wordpress.com
virt-top is 'top' for virtual machines.  Tiny program with many
powerful monitoring features, net stats, disk stats, logging, etc.
http://people.redhat.com/~rjones/virt-top

On Wed, Jun 17, 2020 at 8:54 AM Richard W.M. Jones <rjones@redhat.com>
wrote:
> On Wed, Jun 17, 2020 at 08:42:19AM -0600, alan somers wrote:
> > On Wed, Jun 17, 2020 at 5:23 AM Richard W.M. Jones
<rjones@redhat.com>
> > wrote:
> >
> > > I pushed 2 & 3, thanks.
> > >
> > > But ...
> > >
> > > > From 9fa3e443467e3c06761ec54241327e8daf8701ca Mon Sep 17
00:00:00
> 2001
> > > > From: Alan Somers <asomers@gmail.com>
> > > > Date: Mon, 15 Jun 2020 16:59:53 -0600
> > > > Subject: [PATCH 1/3] Add a Cargo.toml file to the top-level
directory
> > > >
> > > > This is necessary for other Rust projects to depend on
unrelesed
> > > > versions of the nbdkit crate.
> > > > ---
> > > >  Cargo.toml | 2 ++
> > > >  1 file changed, 2 insertions(+)
> > > >  create mode 100644 Cargo.toml
> > > >
> > > > diff --git a/Cargo.toml b/Cargo.toml
> > > > new file mode 100644
> > > > index 00000000..f50a66b7
> > > > --- /dev/null
> > > > +++ b/Cargo.toml
> > > > @@ -0,0 +1,2 @@
> > > > +[workspace]
> > > > +members = ["plugins/rust"]
> > >
> > > Is it really absolutely necessary to have this in the top level
> > > directory of the source tree?
> > >
> > > Rich.
> > >
> >
> > Turns out it isn't.  It didn't work when I tried it the first
time, and I
> > thought that this was the reason why.  But it turns out the real
reason
> was
> > because you had been generating your Cargo.toml file with autotools.
> > That's no longer the case, after my last patch.  So you don't
need the
> > workspace Cargo.toml file after all.
>
> OK, thanks for checking that.
>
> If we did need to generate Cargo.toml again in future (eg. to include
> the nbdkit version number) then we might include the generated file
> into git, if that helps.  In other projects we have included selected
> generated files in git for various reasons.
>
> Rich.
>
Yeah, that would work.