From e531ac2ad9b9933711523cd2c76c1b9ad90d7041 Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Tue, 15 Jan 2013 23:32:13 +0100 Subject: doc: Start documenting (guix store). * doc/guix.texi (The Store): Populate. (Introduction): Add cross-reference. Change "package store" to "the store". --- guix/store.scm | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'guix') 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) -- cgit v1.2.3