nixpkgs/pkgs/servers/gpsd/default.nix
Adam Joseph fe5485327e gpsd: fix cross-compilation
Prior to this commit, builds of `pkgsCross.*.gpsd` were failing.

`gpsd` expects `CCVERSION` to be set, and fails if it is not set.
Scons does not guarantee that `CCVERSION` will be set, nor does it
specify under what circumstances it will or will not be set: "This may
or may not be set, depending on the specific C compiler being used."

  https://scons.org/doc/production/HTML/scons-man.html#cv-CCVERSION

Apparently cross-compilation triggers one of those unspecified
circumstances.  There are several bug reports to scons relating to
this:

  https://github.com/SCons/scons/issues/1723
  https://github.com/SCons/scons/issues?q=is%3Aissue+ccversion+is%3Aclosed

`gpsd` does not use `CCVERSION` for any purpose other than printing a
log message at the start of the build:

  d055863603

This commit modifies the log message, replacing `env['CCVERSION']`
with `env['CC']`, since `CC` is always set when using nixpkgs'
standard builder.

With this commit, `pkgsCross.mips64el-linux-gnuabi64.gpsd` and
`pkgsCross.powernv.gpsd` build correctly on x86_64.  Prior to this
commit, they would fail with:

```
scons: Reading SConscript files ...
scons version: 4.1.0
scons is running under Python version: 3.10.5.final.0
gpsd version: 3.23.1
This system is: linux
KeyError: 'CCVERSION':
  File "/build/gpsd-3.23.1/SConstruct", line 69:
    SConscript('SConscript',
  File "/nix/store/0vmqv6f2s8bj2a50gk8g05jcb5scnifb-scons-4.1.0/lib/python3.10/site-packages/SCons/Script/SConscript.py", line 654:
    return method(*args, **kw)
  File "/nix/store/0vmqv6f2s8bj2a50gk8g05jcb5scnifb-scons-4.1.0/lib/python3.10/site-packages/SCons/Script/SConscript.py", line 591:
    return _SConscript(self.fs, *files, **subst_kw)
  File "/nix/store/0vmqv6f2s8bj2a50gk8g05jcb5scnifb-scons-4.1.0/lib/python3.10/site-packages/SCons/Script/SConscript.py", line 280:
    exec(compile(scriptdata, scriptname, 'exec'), call_stack[-1].globals)
  File "/build/gpsd-3.23.1/gpsd-3.23.1/SConscript", line 883:
    announce("cc is %s, version %s" % (env['CC'], env['CCVERSION']))
  File "/nix/store/0vmqv6f2s8bj2a50gk8g05jcb5scnifb-scons-4.1.0/lib/python3.10/site-packages/SCons/Environment.py", line 388:
    return self._dict[key]
```
2022-08-19 10:20:03 +02:00

143 lines
3.7 KiB
Nix

{ stdenv
, lib
, fetchurl
# nativeBuildInputs
, scons
, pkg-config
# buildInputs
, dbus
, libusb1
, ncurses
, pps-tools
, python3Packages
# optional deps for GUI packages
, guiSupport ? true
, dbus-glib
, libX11
, libXt
, libXpm
, libXaw
, libXext
, gobject-introspection
, pango
, gdk-pixbuf
, atk
, wrapGAppsHook
, gpsdUser ? "gpsd", gpsdGroup ? "dialout"
}:
stdenv.mkDerivation rec {
pname = "gpsd";
version = "3.23.1";
src = fetchurl {
url = "mirror://savannah/${pname}/${pname}-${version}.tar.gz";
sha256 = "sha256-C5kc6aRlOMTqRQ96juQo/0T7T41mX93y/+QP4K6abAk=";
};
# TODO: render & install HTML documentation using asciidoctor
nativeBuildInputs = [
pkg-config
python3Packages.wrapPython
scons
] ++ lib.optionals guiSupport [
gobject-introspection
wrapGAppsHook
];
buildInputs = [
dbus
libusb1
ncurses
pps-tools
python3Packages.python
] ++ lib.optionals guiSupport [
atk
dbus-glib
gdk-pixbuf
gobject-introspection
libX11
libXaw
libXext
libXpm
libXt
pango
];
pythonPath = lib.optionals guiSupport [
python3Packages.pygobject3
python3Packages.pycairo
];
patches = [
./sconstruct-env-fixes.patch
];
preBuild = ''
patchShebangs .
sed -e "s|systemd_dir = .*|systemd_dir = '$out/lib/systemd/system'|" -i SConscript
export TAR=noop
substituteInPlace SConscript --replace "env['CCVERSION']" "env['CC']"
sconsFlags+=" udevdir=$out/lib/udev"
sconsFlags+=" python_libdir=$out/lib/${python3Packages.python.libPrefix}/site-packages"
'';
# - leapfetch=no disables going online at build time to fetch leap-seconds
# info. See <gpsd-src>/build.txt for more info.
sconsFlags = [
"leapfetch=no"
"gpsd_user=${gpsdUser}"
"gpsd_group=${gpsdGroup}"
"systemd=yes"
"xgps=${if guiSupport then "True" else "False"}"
];
preCheck = ''
export LD_LIBRARY_PATH="$PWD"
'';
# TODO: the udev rules file and the hotplug script need fixes to work on NixOS
preInstall = ''
mkdir -p "$out/lib/udev/rules.d"
'';
installTargets = [ "install" "udev-install" ];
# remove binaries for x-less install because xgps sconsflag is partially broken
postFixup = ''
wrapPythonProgramsIn $out/bin "$out $pythonPath"
'';
meta = with lib; {
description = "GPS service daemon";
longDescription = ''
gpsd is a service daemon that monitors one or more GPSes or AIS
receivers attached to a host computer through serial or USB ports,
making all data on the location/course/velocity of the sensors
available to be queried on TCP port 2947 of the host computer. With
gpsd, multiple location-aware client applications (such as navigational
and wardriving software) can share access to receivers without
contention or loss of data. Also, gpsd responds to queries with a
format that is substantially easier to parse than the NMEA 0183 emitted
by most GPSes. The gpsd distribution includes a linkable C service
library, a C++ wrapper class, and a Python module that developers of
gpsd-aware applications can use to encapsulate all communication with
gpsd. Third-party client bindings for Java and Perl also exist.
Besides gpsd itself, the project provides auxiliary tools for
diagnostic monitoring and profiling of receivers and feeding
location-aware applications GPS/AIS logs for diagnostic purposes.
'';
homepage = "https://gpsd.gitlab.io/gpsd/index.html";
changelog = "https://gitlab.com/gpsd/gpsd/-/blob/release-${version}/NEWS";
license = licenses.bsd2;
platforms = platforms.linux;
maintainers = with maintainers; [ bjornfor rasendubi ];
};
}