> Could you copy/paste the --format option found in (guix scripts
> download)?

I changed it a bit.

(By the way, I'd like to add your copyright to the header of 'hash.scm'.
What year should be used?)

>> Should we capitalize error messages?

> No (info "(standards) Errors"): [...]

OK, I prepended 'guix hash' to all messages.  I'd like to change other
commands (e.g., 'guix download') accordingly.  What do you think?

I also want to change the output of 'guix download --help'.  In
particular, I'd like to specify the supported formats and remove
(default: `nix-base32').  Basically, I want it to look like the output
of 'guix hash --help'.

>> Is it OK to output a backtrace when the specified file doesn't exist?

> No, because it’s too scaring.  :-)

Done.

> Also, could you add an entry in the manual (with a couple of sentences
> explaining when users should care about this tool, and what it does), as
> well as a line in po/POTFILES.in?

Done.  But what is a translatable string?  Is it a string that should be
i18n'd?

Do you have any suggestions regarding the manual entry of 'guix hash'?
The current version looks rough to me.

From 4e36644099b71057d01fe3299036c06204ddd326 Mon Sep 17 00:00:00 2001
From: Nikita Karetnikov <nik...@karetnikov.org>
Date: Fri, 5 Apr 2013 13:10:25 +0000
Subject: [PATCH] Add 'guix hash'.

* guix/scripts/hash.scm: New file.
* Makefile.am (MODULES): Add it.
* po/POTFILES.in: Add it.
* doc/guix.texi (Invoking guix hash): New node.
---
 Makefile.am           |    1 +
 doc/guix.texi         |   37 +++++++++++++++
 guix/scripts/hash.scm |  118 +++++++++++++++++++++++++++++++++++++++++++++++++
 po/POTFILES.in        |    1 +
 4 files changed, 157 insertions(+), 0 deletions(-)
 create mode 100644 guix/scripts/hash.scm

diff --git a/Makefile.am b/Makefile.am
index 136c01b..eb8b80f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -30,6 +30,7 @@ MODULES =					\
   guix/scripts/import.scm			\
   guix/scripts/package.scm			\
   guix/scripts/gc.scm				\
+  guix/scripts/hash.scm				\
   guix/scripts/pull.scm				\
   guix/scripts/substitute-binary.scm		\
   guix/base32.scm				\
diff --git a/doc/guix.texi b/doc/guix.texi
index 1be172c..b24a92e 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -1087,6 +1087,7 @@ space.
 
 @menu
 * Invoking guix build:: Building packages from the command line.
+* Invoking guix hash:: Computing the cryptographic hash of a file.
 @end menu
 
 @node Invoking guix build
@@ -1182,6 +1183,42 @@ the @code{package-derivation} procedure of the @code{(guix packages)}
 module, and to the @code{build-derivations} procedure of the @code{(guix
 store)} module.
 
+@node Invoking guix hash
+@section Invoking @command{guix hash}
+
+The @command{guix hash} command computes the cryptographic hash of a
+file.
+
+The general syntax is:
+
+@example
+guix hash @var{option} @var{file}
+@end example
+
+@command{guix hash} has the following option:
+
+@table @code
+
+@item --format=@var{fmt}
+@itemx -f @var{fmt}
+Write the hash in the given format.
+
+Supported formats: @code{nix-base32}, @code{base32}, @code{base16}
+(@code{hex} and @code{hexadecimal} can be used as well).
+
+If the @option{--format} option is not specified, @command{guix hash}
+will output the hash in @code{nix-base32}.  This representation is used
+in the definitions of packages.
+
+@end table
+
+@command{guix hash} is a convenient tool to check the integrity of a
+file.  For example, it can be used to compute the hashes of bootstrap
+binaries.
+
+There is also @code{guix download} which computes the hash of a remote
+file.
+
 @c *********************************************************************
 @node GNU Distribution
 @chapter GNU Distribution
diff --git a/guix/scripts/hash.scm b/guix/scripts/hash.scm
new file mode 100644
index 0000000..424f3b9
--- /dev/null
+++ b/guix/scripts/hash.scm
@@ -0,0 +1,118 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2013 Nikita Karetnikov <nik...@karetnikov.org>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (guix scripts hash)
+    #:use-module (guix base32)
+    #:use-module (guix ui)
+    #:use-module (guix utils)
+    #:use-module (rnrs io ports)
+    #:use-module (rnrs files)
+    #:use-module (ice-9 match)
+    #:use-module (srfi srfi-1)
+    #:use-module (srfi srfi-26)
+    #:use-module (srfi srfi-37)
+    #:export (guix-hash))
+
+
+;;;
+;;; Command-line options.
+;;;
+
+(define %default-options
+  ;; Alist of default option values.
+  `((format . ,bytevector->nix-base32-string)))
+
+(define (show-help)
+  (display (_ "Usage: guix hash [OPTION] FILE
+Return the cryptographic hash of FILE.
+
+Supported formats: 'nix-base32' (default), 'base32', and 'base16'
+('hex' and 'hexadecimal' can be used as well).\n"))
+  (format #t (_ "
+  -f, --format=FMT       write the hash in the given format"))
+  (newline)
+  (display (_ "
+  -h, --help             display this help and exit"))
+  (display (_ "
+  -V, --version          display version information and exit"))
+  (newline)
+  (show-bug-report-information))
+
+(define %options
+  ;; Specification of the command-line options.
+  (list (option '(#\f "format") #t #f
+                (lambda (opt name arg result)
+                  (define fmt-proc
+                    (match arg
+                      ("nix-base32"
+                       bytevector->nix-base32-string)
+                      ("base32"
+                       bytevector->base32-string)
+                      ((or "base16" "hex" "hexadecimal")
+                       bytevector->base16-string)
+                      (x
+                       (leave (_ "~a: unsupported hash format: ~a~%")
+                              "guix hash" arg))))
+
+                  (alist-cons 'format fmt-proc
+                              (alist-delete 'format result))))
+
+        (option '(#\h "help") #f #f
+                (lambda args
+                  (show-help)
+                  (exit 0)))
+        (option '(#\V "version") #f #f
+                (lambda args
+                  (show-version-and-exit "guix hash")))))
+
+
+
+;;;
+;;; Entry point.
+;;;
+
+(define (guix-hash . args)
+  (define (parse-options)
+    ;; Return the alist of option values.
+    (args-fold args %options
+               (lambda (opt name arg result)
+                 (leave (_ "~a: unrecognized option: ~a~%")
+                        "guix hash" name))
+               (lambda (arg result)
+                 (alist-cons 'argument arg result))
+               %default-options))
+
+    (let* ((opts (parse-options))
+           (args (filter-map (match-lambda
+                              (('argument . value)
+                               value)
+                              (_ #f))
+                             (reverse opts)))
+           (fmt  (assq-ref opts 'format)))
+
+      (match args
+        ((file)
+         (if (file-exists? file)
+             (format #t "~a~%"
+                     (call-with-input-file file
+                       (compose fmt sha256 get-bytevector-all)))
+             (leave (_ "~a: file '~a' does not exist~%")
+                    "guix hash" (basename file))))
+        (_
+         (leave (_ "~a: wrong number of arguments~%")
+                "guix hash")))))
diff --git a/po/POTFILES.in b/po/POTFILES.in
index bdb894d..3c712a4 100644
--- a/po/POTFILES.in
+++ b/po/POTFILES.in
@@ -8,5 +8,6 @@ guix/scripts/build.scm
 guix/scripts/download.scm
 guix/scripts/package.scm
 guix/scripts/gc.scm
+guix/scripts/hash.scm
 guix/scripts/pull.scm
 guix/ui.scm
-- 
1.7.5.4

Attachment: pgpbDKtlvQLHe.pgp
Description: PGP signature

Reply via email to