distro packaging, makefiles, deps, systemd, new tools

distro packaging, makefiles, deps, systemd, new tools

[Jason A. Donenfeld]

Hey Christian, Daniel, Dan, and other maintainers,

The next snapshot is going to have some improvements to the tooling,
and along with this comes a more complicated Makefile. I wanted to run
the changes by y'all (downstreams).

- The makefile now has a few WITH_{FEATURE}=yes|no environment flags,
as well as auto-detection. Documentation is here:
https://git.zx2c4.com/WireGuard/plain/src/tools/INSTALL
And the Makefile itself is here:
https://git.zx2c4.com/WireGuard/tree/src/tools/Makefile

Question: does this propose a desirable situation for you as a downstream?


- The wg-config script is now called wg-quick and is quite simple and
nice. Documentation:
https://git.zx2c4.com/WireGuard/about/src/tools/wg-quick.8
And source:
https://git.zx2c4.com/WireGuard/tree/src/tools/wg-quick.bash

OpenWRT should _not_ ship this. NixOS probably should not ship this.
When systemd-networkd gets support for WireGuard, systemd-based
distros should not ship this. But everybody else who just wants a
simple rough script for quickly bringing up and down VPNs can ship
this, as it's a big help to users. It's installed according to the
documentation for the Makefile above.

- There's now an "upstream" systemd unit for wg-quick, called
wg-quick@.service. It's pretty simple:
https://git.zx2c4.com/WireGuard/tree/src/tools/wg-quick@.service

Question: does this unit seem sane to you? Can you ship it downstream
as is, or will you need modifications?

Thanks,
Jason

[PATCH 1/1] tools: remove DESTDIR for autodetection

[Christian Hesse]

From: Christian Hesse <mail@eworm.de>

DESTDIR is always empty, no need to check anything there. Check the main
system instead.

Signed-off-by: Christian Hesse <mail@eworm.de>
---
 src/tools/Makefile | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/tools/Makefile b/src/tools/Makefile
index fe483b9..8160cc9 100644
--- a/src/tools/Makefile
+++ b/src/tools/Makefile
@@ -12,12 +12,12 @@ WITH_WGQUICK ?=
 WITH_SYSTEMDUNITS ?=
 
 ifeq ($(WITH_BASHCOMPLETION),)
-ifneq ($(strip $(wildcard $(DESTDIR)$(BASHCOMPDIR))),)
+ifneq ($(strip $(wildcard $(BASHCOMPDIR))),)
 WITH_BASHCOMPLETION := yes
 endif
 endif
 ifeq ($(WITH_WGQUICK),)
-ifneq ($(strip $(wildcard $(DESTDIR)$(BINDIR)/bash)),)
+ifneq ($(strip $(wildcard $(BINDIR)/bash)),)
 WITH_WGQUICK := yes
 endif
 ifneq ($(strip $(wildcard $(DESTDIR)/bin/bash)),)
@@ -25,7 +25,7 @@ WITH_WGQUICK := yes
 endif
 endif
 ifeq ($(WITH_SYSTEMDUNITS),)
-ifneq ($(strip $(wildcard $(DESTDIR)$(SYSTEMDUNITDIR))),)
+ifneq ($(strip $(wildcard $(SYSTEMDUNITDIR))),)
 WITH_SYSTEMDUNITS := yes
 endif
 endif
-- 
2.11.0

Re: [PATCH 1/1] tools: remove DESTDIR for autodetection

[Jason A. Donenfeld]

Hey Christian,

Seems reasonable to me.

Merged.

Jason

Re: [PATCH 1/1] tools: remove DESTDIR for autodetection

[Daniel Kahn Gillmor]

On Wed 2017-01-04 15:14:16 -0500, Christian Hesse wrote:
> From: Christian Hesse <mail@eworm.de>
>
> DESTDIR is always empty, no need to check anything there. Check the main
> system instead.

why are we checking either place?  It's entirely possible that my
dedicated build farm doesn't have any bash completion mechanisms
installed, even if my development system does.

           --dkg

Re: [PATCH 1/1] tools: remove DESTDIR for autodetection

[Jason A. Donenfeld]

On Wed, Jan 4, 2017 at 10:02 PM, Daniel Kahn Gillmor
<dkg@fifthhorseman.net> wrote:
> why are we checking either place?  It's entirely possible that my
> dedicated build farm doesn't have any bash completion mechanisms
> installed, even if my development system does.

Yes, the concept of auto-detection is "broken". But it's useful as a
default, for people doing `make && make install` on their dev
machines. Packagers should always set these types of flags explicitly,
as with autotools.

Re: [PATCH 1/1] tools: remove DESTDIR for autodetection

[Jason A. Donenfeld]

For reference, the Gentoo 9999 ebuild does this:

https://gitweb.gentoo.org/repo/gentoo.git/tree/net-misc/wireguard/wireguard-9999.ebuild#n51

emake \
WITH_BASHCOMPLETION=yes \
WITH_SYSTEMDUNITS=yes \
WITH_WGQUICK=yes \
DESTDIR="${D}" \
BASHCOMPDIR="$(get_bashcompdir)" \
PREFIX="${EPREFIX}/usr" \
-C src/tools install

I imagine Debian and Arch will do something similar, perhaps leaving
out explicitly setting BASHCOMPDIR if you use standard patches. I
expect for OpenWRT to set all of these explicitly to "no". Etc.

Jason

Re: distro packaging, makefiles, deps, systemd, new tools

[Daniel Kahn Gillmor]

[-- Attachment #1: Type: text/plain, Size: 1827 bytes --]

On Wed 2017-01-04 13:50:14 -0500, Jason A. Donenfeld wrote:
> Hey Christian, Daniel, Dan, and other maintainers,
>
> The next snapshot is going to have some improvements to the tooling,
> and along with this comes a more complicated Makefile. I wanted to run
> the changes by y'all (downstreams).
>
> - The makefile now has a few WITH_{FEATURE}=yes|no environment flags,
> as well as auto-detection. Documentation is here:
> https://git.zx2c4.com/WireGuard/plain/src/tools/INSTALL
> And the Makefile itself is here:
> https://git.zx2c4.com/WireGuard/tree/src/tools/Makefile
>
> Question: does this propose a desirable situation for you as a downstream?

Reading through INSTALL, these parameters look reasonable to me as a
downstream.

> - The wg-config script is now called wg-quick and is quite simple and
> nice. Documentation:
> https://git.zx2c4.com/WireGuard/about/src/tools/wg-quick.8
> And source:
> https://git.zx2c4.com/WireGuard/tree/src/tools/wg-quick.bash
>
> OpenWRT should _not_ ship this. NixOS probably should not ship this.
> When systemd-networkd gets support for WireGuard, systemd-based
> distros should not ship this. But everybody else who just wants a
> simple rough script for quickly bringing up and down VPNs can ship
> this, as it's a big help to users. It's installed according to the
> documentation for the Makefile above.

this also looks good.

> - There's now an "upstream" systemd unit for wg-quick, called
> wg-quick@.service. It's pretty simple:
> https://git.zx2c4.com/WireGuard/tree/src/tools/wg-quick@.service
>
> Question: does this unit seem sane to you? Can you ship it downstream
> as is, or will you need modifications?

although i haven't tested it, a quick read through the .service file
looks reasonable to me.  Thanks for thinking about system integration
stuff.

        --dkg

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: distro packaging, makefiles, deps, systemd, new tools

[Dan Lüdtke]

> On 4 Jan 2017, at 19:50, Jason A. Donenfeld <Jason@zx2c4.com> wrote:
>=20
> OpenWRT should _not_ ship this. =08=0D

Agreed.

Everything else looks good to me. Just had a brief look at it.

Let's see what buildbot says. Should all run smoothly!

Re: distro packaging, makefiles, deps, systemd, new tools

[Jason A. Donenfeld]

[-- Attachment #1: Type: text/plain, Size: 419 bytes --]

On Jan 6, 2017 23:44, "Dan Lüdtke" <mail@danrl.com> wrote:


> On 4 Jan 2017, at 19:50, Jason A. Donenfeld <Jason@zx2c4.com> wrote:
>
> OpenWRT should _not_ ship this.


Agreed.

Everything else looks good to me. Just had a brief look at it.

Let's see what buildbot says. Should all run smoothly!


I assume youre not shipping the bash completion stuff either, right? Since
openwrt doesn't use bash.

[-- Attachment #2: Type: text/html, Size: 933 bytes --]

Re: distro packaging, makefiles, deps, systemd, new tools

[Dan Lüdtke]

> I assume youre not shipping the bash completion stuff either, right? =
Since openwrt doesn't use bash.

We are not shipping it.

FYI: The topic is discussed right now in this PR:
https://github.com/openwrt/packages/pull/3816=

Re: distro packaging, makefiles, deps, systemd, new tools

[Anonymous Anonymous]

We could move wg-quick in separate package in case hardly useful networkd support will be implemented.
As, for now it obviously reasonable to ship it inside wireguard-tools package. 
Also, are bash completions for wg-quick came with WITH_BASHCOMPLETION or with WITH_WGQUICK itself?

On Wed, Jan 4, 2017, at 12:50, Jason A. Donenfeld wrote:

> When systemd-networkd gets support for WireGuard, systemd-based
> distros should not ship this. But everybody else who just wants a
> simple rough script for quickly bringing up and down VPNs can ship
> this, as it's a big help to users. It's installed according to the
> documentation for the Makefile above.
> 
> - There's now an "upstream" systemd unit for wg-quick, called
> wg-quick@.service. It's pretty simple:
> https://git.zx2c4.com/WireGuard/tree/src/tools/wg-quick@.service
> 
> Question: does this unit seem sane to you? Can you ship it downstream
> as is, or will you need modifications?
> 
> Thanks,
> Jason
> _______________________________________________
> WireGuard mailing list
> WireGuard@lists.zx2c4.com
> https://lists.zx2c4.com/mailman/listinfo/wireguard
> 

Re: distro packaging, makefiles, deps, systemd, new tools

[Jason A. Donenfeld]

On Wed, Jan 4, 2017 at 10:56 PM, Anonymous Anonymous <admin@hda.me> wrote:
> Also, are bash completions for wg-quick came with WITH_BASHCOMPLETION or with WITH_WGQUICK itself?

wg bash completion: WITH_BASHCOMPLETION
wg-quick: WITH_WGQUICK
wg-quick bash completion: WITH_BASHCOMPLETION && WITH_WGQUICK