aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2023-05-28 22:44:52 +0200
committerLudovic Courtès <ludo@gnu.org>2023-05-31 23:25:26 +0200
commit57ceb64e3464c347f42bd883e394163904f928ec (patch)
treea6174d355bef31c2cc4441b754d0159ad8f4690e /doc
parent9e237fe0bd813664adf54599586df75b2e5b0998 (diff)
downloadguix-57ceb64e3464c347f42bd883e394163904f928ec.tar.gz
guix-57ceb64e3464c347f42bd883e394163904f928ec.zip
upstream: Honor package properties for ignored and extra inputs.
* guix/upstream.scm (update-package-inputs)[filtered-inputs] [regular-inputs, native-inputs, propagated-inputs]: New procedures. Use them in 'update-field' calls. * tests/guix-refresh.sh (GUIX_TEST_UPDATER_TARGETS): Add "libreoffice" to the dependencies of "the-test-package". Add 'updater-ignored-inputs' property to "the-test-package". * doc/guix.texi (Invoking guix refresh): Document it.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index b83767aaf4..7f8d8d66e9 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -14359,6 +14359,36 @@ guix refresh -L /path/to/channel -u @var{package}
@xref{Creating a Channel}, on how to create a channel.
+This command updates the version and source code hash of the package.
+Depending on the updater being used, it can also update the various
+@samp{inputs} fields of the package. In some cases, the updater might
+get inputs wrong---it might not know about an extra input that's
+necessary, or it might add an input that should be avoided.
+
+@cindex @code{updater-extra-inputs}, package property
+@cindex @code{updater-ignored-inputs}, package property
+To address that, packagers can add properties stating inputs that should
+be added to those found by the updater or inputs that should be ignored:
+the @code{updater-extra-inputs} and @code{updater-ignored-inputs}
+properties pertain to ``regular'' inputs, and there are equivalent
+properties for @samp{native} and @samp{propagated} inputs. In the
+example below, we tell the updater that we need @samp{openmpi} as an
+additional input:
+
+@lisp
+(define-public python-mpi4py
+ (package
+ (name "python-mpi4py")
+ ;; @dots{}
+ (inputs (list openmpi))
+ (properties
+ '((updater-extra-inputs . ("openmpi"))))))
+@end lisp
+
+That way, @command{guix refresh -u python-mpi4py} will leave the
+@samp{openmpi} input, even if it is not among the inputs it would
+normally add.
+
@item --select=[@var{subset}]
@itemx -s @var{subset}
Select all the packages in @var{subset}, one of @code{core}, @code{non-core}
href='#n207'>207 208 209 210
# GNU Guix --- Functional package management for GNU
# Copyright © 2012, 2013, 2014, 2015 Ludovic Courtès <ludo@gnu.org>
#
# This file is part of GNU Guix.
#
# GNU Guix is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or (at
# your option) any later version.
#
# GNU Guix is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

#
# Integration of the `guix-daemon' code taken from upstream Nix.
#

BUILT_SOURCES += nix/libstore/schema.sql.hh
CLEANFILES += $(BUILT_SOURCES) etc/guix-daemon.service

noinst_LIBRARIES = libformat.a libutil.a libstore.a

# Use '-std=c++11' for 'std::shared_ptr', 'auto', lambdas, and more.
AM_CXXFLAGS = -Wall -std=c++11

libformat_a_SOURCES =				\
  nix/boost/format/free_funcs.cc		\
  nix/boost/format/parsing.cc			\
  nix/boost/format/format_implementation.cc

libformat_headers =				\
  nix/boost/throw_exception.hpp			\
  nix/boost/format.hpp				\
  nix/boost/assert.hpp				\
  nix/boost/format/macros_default.hpp		\
  nix/boost/format/format_fwd.hpp		\
  nix/boost/format/format_class.hpp		\
  nix/boost/format/exceptions.hpp		\
  nix/boost/format/group.hpp			\
  nix/boost/format/feed_args.hpp		\
  nix/boost/format/internals_fwd.hpp		\
  nix/boost/format/internals.hpp

libformat_a_CPPFLAGS =				\
  -I$(top_srcdir)/nix

libutil_a_SOURCES =				\
  nix/libutil/archive.cc			\
  nix/libutil/affinity.cc			\
  nix/libutil/serialise.cc			\
  nix/libutil/util.cc				\
  nix/libutil/xml-writer.cc			\
  nix/libutil/hash.cc				\
  nix/libutil/gcrypt-hash.cc

libutil_headers =				\
  nix/libutil/affinity.hh			\
  nix/libutil/hash.hh				\
  nix/libutil/serialise.hh			\
  nix/libutil/xml-writer.hh			\
  nix/libutil/util.hh				\
  nix/libutil/archive.hh			\
  nix/libutil/types.hh				\
  nix/libutil/gcrypt-hash.hh			\
  nix/libutil/md5.h				\
  nix/libutil/sha1.h				\
  nix/libutil/sha256.h

libutil_a_CPPFLAGS =				\
  -I$(top_builddir)/nix				\
  -I$(top_srcdir)/nix/libutil			\
  $(libformat_a_CPPFLAGS)

libstore_a_SOURCES =				\
  nix/libstore/gc.cc				\
  nix/libstore/globals.cc			\
  nix/libstore/misc.cc				\
  nix/libstore/references.cc			\
  nix/libstore/store-api.cc			\
  nix/libstore/optimise-store.cc		\
  nix/libstore/local-store.cc			\
  nix/libstore/remote-store.cc			\
  nix/libstore/build.cc				\
  nix/libstore/pathlocks.cc			\
  nix/libstore/derivations.cc

libstore_headers =				\
  nix/libstore/references.hh			\
  nix/libstore/pathlocks.hh			\
  nix/libstore/globals.hh			\
  nix/libstore/schema.sql.hh			\
  nix/libstore/worker-protocol.hh		\
  nix/libstore/remote-store.hh			\
  nix/libstore/derivations.hh			\
  nix/libstore/misc.hh				\
  nix/libstore/local-store.hh			\
  nix/libstore/store-api.hh

libstore_a_CPPFLAGS =				\
  $(libutil_a_CPPFLAGS)				\
  -I$(top_srcdir)/nix/libstore			\
  -I$(top_builddir)/nix/libstore		\
  -DNIX_STORE_DIR=\"$(storedir)\"		\
  -DNIX_DATA_DIR=\"$(datadir)\"			\
  -DNIX_STATE_DIR=\"$(localstatedir)/guix\"	\
  -DNIX_LOG_DIR=\"$(localstatedir)/log/guix\"	\
  -DNIX_CONF_DIR=\"$(sysconfdir)/guix\"		\
  -DNIX_LIBEXEC_DIR=\"$(libexecdir)\"		\
  -DNIX_BIN_DIR=\"$(bindir)\"			\
  -DOPENSSL_PATH="\"guix-authenticate\""	\
  -DDEFAULT_CHROOT_DIRS="\"\""

libstore_a_CXXFLAGS = $(AM_CXXFLAGS)		\
  $(SQLITE3_CFLAGS) $(LIBGCRYPT_CFLAGS)

bin_PROGRAMS = guix-daemon
sbin_PROGRAMS = guix-register

guix_daemon_SOURCES =				\
  nix/nix-daemon/nix-daemon.cc			\
  nix/nix-daemon/guix-daemon.cc

guix_daemon_CPPFLAGS =				\
  -DLOCALEDIR=\"$(localedir)\"			\
  $(libutil_a_CPPFLAGS)				\
  -I$(top_srcdir)/nix/libstore

guix_daemon_LDADD =				\
  libstore.a libutil.a libformat.a -lbz2	\
  $(SQLITE3_LIBS) $(LIBGCRYPT_LIBS)

guix_daemon_headers =				\
  nix/nix-daemon/shared.hh


guix_register_SOURCES =				\
  nix/guix-register/guix-register.cc

guix_register_CPPFLAGS =			\
  $(libutil_a_CPPFLAGS)				\
  $(libstore_a_CPPFLAGS)			\
  -I$(top_srcdir)/nix/libstore

# XXX: Should we start using shared libs?
guix_register_LDADD =				\
  libstore.a libutil.a libformat.a -lbz2	\
  $(SQLITE3_LIBS) $(LIBGCRYPT_LIBS)


noinst_HEADERS =						\
  $(libformat_headers) $(libutil_headers) $(libstore_headers)	\
  $(guix_daemon_headers)

nix/libstore/schema.sql.hh: nix/libstore/schema.sql
	$(GUILE) --no-auto-compile -c				\
	  "(use-modules (rnrs io ports))			\
	   (call-with-output-file \"$@\"			\
	     (lambda (out)					\
	       (call-with-input-file \"$^\"			\
	         (lambda (in)					\
	           (write (get-string-all in) out)))))"

nodist_pkglibexec_SCRIPTS =			\
  nix/scripts/list-runtime-roots		\
  nix/scripts/substitute

if BUILD_DAEMON_OFFLOAD

nodist_pkglibexec_SCRIPTS +=			\
  nix/scripts/offload

endif BUILD_DAEMON_OFFLOAD


# XXX: It'd be better to hide it in $(pkglibexecdir).
nodist_libexec_SCRIPTS =			\
  nix/scripts/guix-authenticate

# The '.service' file for systemd.
systemdservicedir = $(libdir)/systemd/system
nodist_systemdservice_DATA = etc/guix-daemon.service

etc/guix-daemon.service: etc/guix-daemon.service.in	\
			 $(top_builddir)/config.status
	$(SED) -e 's|@''bindir''@|$(bindir)|' <		\
	       "etc/guix-daemon.service.in" > "$@.tmp"
	mv "$@.tmp" "$@"

EXTRA_DIST +=					\
  nix/libstore/schema.sql			\
  nix/AUTHORS					\
  nix/COPYING					\
  etc/guix-daemon.service.in

AM_TESTS_ENVIRONMENT +=				\
  top_builddir="$(abs_top_builddir)"

TESTS +=					\
  tests/guix-daemon.sh

clean-local:
	-if test -d "$(GUIX_TEST_ROOT)"; then		\
	  find "$(GUIX_TEST_ROOT)" | xargs chmod +w;	\
	 fi
	-rm -rf "$(GUIX_TEST_ROOT)"