~ruther/guix-local

a5e03674d1c5a3ea2e188b909a14ce1ac87b8773 — Ludovic Courtès 8 years ago 76dbb75
doc: Document the 'upstream-name' property.

Reported by Hartmut Goebel <h.goebel@crazy-compilers.com>.

* doc/guix.texi (Invoking guix refresh): Document 'upstream-name'.
1 files changed, 13 insertions(+), 0 deletions(-)

M doc/guix.texi
M doc/guix.texi => doc/guix.texi +13 -0
@@ 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