guix-kreyren/guix/scripts/import.scm
Alex Kost 2a4e2e4b01 guix: Clean up --help messages.
* guix/scripts/import.scm (show-help): Add newline before a list of
  importers.
* guix/scripts/lint.scm (show-help): Split a long description line.
* guix/scripts/package.scm (show-help): Improve docstrings for --install
  and --remove options.
* guix/scripts/system.scm (show-help): Format actions the same way as
  guix commands and importers are formatted.
2015-06-08 11:46:05 +03:00

114 lines
3.5 KiB
Scheme
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2012, 2013, 2014 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2014 David Thompson <davet@gnu.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 import)
#:use-module (guix ui)
#:use-module (guix utils)
#:use-module (srfi srfi-1)
#:use-module (srfi srfi-11)
#:use-module (srfi srfi-26)
#:use-module (srfi srfi-37)
#:use-module (ice-9 format)
#:use-module (ice-9 match)
#:use-module (ice-9 pretty-print)
#:export (%standard-import-options
guix-import))
;;;
;;; Helper.
;;;
(define (newline-rewriting-port output)
"Return an output port that rewrites strings containing the \\n escape
to an actual newline. This works around the behavior of `pretty-print'
and `write', which output these as \\n instead of actual newlines,
whereas we want the `description' field to contain actual newlines
rather than \\n."
(define (write-string str)
(let loop ((chars (string->list str)))
(match chars
(()
#t)
((#\\ #\n rest ...)
(newline output)
(loop rest))
((chr rest ...)
(write-char chr output)
(loop rest)))))
(make-soft-port (vector (cut write-char <>)
write-string
(lambda _ #t) ; flush
#f
(lambda _ #t) ; close
#f)
"w"))
;;;
;;; Command line options.
;;;
(define %standard-import-options '())
;;;
;;; Entry point.
;;;
(define importers '("gnu" "nix" "pypi" "cpan" "hackage"))
(define (resolve-importer name)
(let ((module (resolve-interface
`(guix scripts import ,(string->symbol name))))
(proc (string->symbol (string-append "guix-import-" name))))
(module-ref module proc)))
(define (show-help)
(display (_ "Usage: guix import IMPORTER ARGS ...
Run IMPORTER with ARGS.\n"))
(newline)
(display (_ "IMPORTER must be one of the importers listed below:\n"))
(newline)
(format #t "~{ ~a~%~}" importers)
(display (_ "
-h, --help display this help and exit"))
(display (_ "
-V, --version display version information and exit"))
(newline)
(show-bug-report-information))
(define (guix-import . args)
(match args
(()
(format (current-error-port)
(_ "guix import: missing importer name~%")))
((or ("-h") ("--help"))
(show-help)
(exit 0))
(("--version")
(show-version-and-exit "guix import"))
((importer args ...)
(if (member importer importers)
(let ((expr (apply (resolve-importer importer) args)))
(pretty-print expr (newline-rewriting-port (current-output-port))))
(format (current-error-port)
(_ "guix import: invalid importer~%"))))))