summaryrefslogtreecommitdiff
path: root/doc/guix.texi
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2018-02-05 12:13:24 +0100
committerLudovic Courtès <ludo@gnu.org>2018-02-05 16:54:27 +0100
commita5e03674d1c5a3ea2e188b909a14ce1ac87b8773 (patch)
tree339c2e40b2ffffe916dcc4342cf86cccf08fe70e /doc/guix.texi
parent76dbb7516e13b8e24d88be34048ee4a83b0d2981 (diff)
downloadpatches-a5e03674d1c5a3ea2e188b909a14ce1ac87b8773.tar
patches-a5e03674d1c5a3ea2e188b909a14ce1ac87b8773.tar.gz
doc: Document the 'upstream-name' property.
Reported by Hartmut Goebel <h.goebel@crazy-compilers.com>. * doc/guix.texi (Invoking guix refresh): Document 'upstream-name'.
Diffstat (limited to 'doc/guix.texi')
-rw-r--r--doc/guix.texi13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index cb28c61182..c3b7d07d84 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -6358,6 +6358,19 @@ are many packages, though, for which it lacks a method to determine
whether a new upstream release is available. However, the mechanism is
extensible, so feel free to get in touch with us to add a new method!
+Sometimes the upstream name differs from the package name used in Guix,
+and @command{guix refresh} needs a little help. Most updaters honor the
+@code{upstream-name} property in package definitions, which can be used
+to that effect:
+
+@example
+(define-public network-manager
+ (package
+ (name "network-manager")
+ ;; @dots{}
+ (properties '((upstream-name . "NetworkManager")))))
+@end example
+
When passed @code{--update}, it modifies distribution source files to
update the version numbers and source tarball hashes of those package
recipes (@pxref{Defining Packages}). This is achieved by downloading