summaryrefslogtreecommitdiff
path: root/guix/store.scm
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2013-01-15 23:32:13 +0100
committerLudovic Courtès <ludo@gnu.org>2013-01-15 23:32:13 +0100
commite531ac2ad9b9933711523cd2c76c1b9ad90d7041 (patch)
tree5a0ea9b5fd30ce8b6e0e684c873e82eff60a96d9 /guix/store.scm
parent156b5010ff80265ef3ebe538c7b90b909838945f (diff)
downloadgnu-guix-e531ac2ad9b9933711523cd2c76c1b9ad90d7041.tar
gnu-guix-e531ac2ad9b9933711523cd2c76c1b9ad90d7041.tar.gz
doc: Start documenting (guix store).
* doc/guix.texi (The Store): Populate. (Introduction): Add cross-reference. Change "package store" to "the store".
Diffstat (limited to 'guix/store.scm')
-rw-r--r--guix/store.scm8
1 files changed, 7 insertions, 1 deletions
diff --git a/guix/store.scm b/guix/store.scm
index 5111d8f50a..c7eb9a7605 100644
--- a/guix/store.scm
+++ b/guix/store.scm
@@ -308,6 +308,10 @@
(define* (open-connection #:optional (file %default-socket-path)
#:key (reserve-space? #t))
+ "Connect to the daemon over the Unix-domain socket at FILE. When
+RESERVE-SPACE? is true, instruct it to reserve a little bit of extra
+space on the file system so that the garbage collector can still
+operate, should the disk become full. Return a server object."
(let ((s (with-fluids ((%default-port-encoding #f))
;; This trick allows use of the `scm_c_read' optimization.
(socket PF_UNIX SOCK_STREAM 0)))
@@ -446,7 +450,9 @@ again until #t is returned or an error is raised."
(define-operation (add-text-to-store (string name) (string text)
(string-list references))
- "Add TEXT under file NAME in the store."
+ "Add TEXT under file NAME in the store, and return its store path.
+REFERENCES is the list of store paths referred to by the resulting store
+path."
store-path)
(define-operation (add-to-store (string basename)