01/08: doc: Document the 'upstream-name' property.

[Ludovic Courtès]

civodul pushed a commit to branch master
in repository guix.

commit a5e03674d1c5a3ea2e188b909a14ce1ac87b8773
Author: Ludovic Courtès <address@hidden>
Date:   Mon Feb 5 12:13:24 2018 +0100

    doc: Document the 'upstream-name' property.
    
    Reported by Hartmut Goebel <address@hidden>.
    
    * doc/guix.texi (Invoking guix refresh): Document 'upstream-name'.
---
 doc/guix.texi | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/doc/guix.texi b/doc/guix.texi
index cb28c61..c3b7d07 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
address@hidden property in package definitions, which can be used
+to that effect:
+
address@hidden
+(define-public network-manager
+  (package
+    (name "network-manager")
+    ;; @dots{}
+    (properties '((upstream-name . "NetworkManager")))))
address@hidden 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