Update `HACKING'.
[jackhill/guix/guix.git] / distro / packages / idutils.scm
1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2012 Ludovic Courtès <ludo@gnu.org>
3 ;;;
4 ;;; This file is part of GNU Guix.
5 ;;;
6 ;;; GNU Guix is free software; you can redistribute it and/or modify it
7 ;;; under the terms of the GNU General Public License as published by
8 ;;; the Free Software Foundation; either version 3 of the License, or (at
9 ;;; your option) any later version.
10 ;;;
11 ;;; GNU Guix is distributed in the hope that it will be useful, but
12 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;; GNU General Public License for more details.
15 ;;;
16 ;;; You should have received a copy of the GNU General Public License
17 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
18
19 (define-module (distro packages idutils)
20 #:use-module (guix packages)
21 #:use-module (guix download)
22 #:use-module (guix build-system gnu)
23 #:use-module (guix licenses)
24 #:use-module (distro))
25
26 (define-public idutils
27 (package
28 (name "idutils")
29 (version "4.6")
30 (source
31 (origin
32 (method url-fetch)
33 (uri (string-append "mirror://gnu/idutils/idutils-"
34 version ".tar.xz"))
35 (sha256
36 (base32
37 "1hmai3422iaqnp34kkzxdnywl7n7pvlxp11vrw66ybxn9wxg90c1"))))
38 (build-system gnu-build-system)
39 (inputs `(;; TODO: Add Emacs as an input for byte-compilation.
40 ;; ("emacs" ,emacs)
41 ("patch/gets"
42 ,(search-patch "diffutils-gets-undeclared.patch"))))
43 (arguments `(#:patches (list (assoc-ref %build-inputs "patch/gets"))))
44 (home-page "http://www.gnu.org/software/idutils/")
45 (synopsis "GNU Idutils, a text searching utility")
46 (description
47 "An \"ID database\" is a binary file containing a list of file
48 names, a list of tokens, and a sparse matrix indicating which
49 tokens appear in which files.
50
51 With this database and some tools to query it, many
52 text-searching tasks become simpler and faster. For example,
53 you can list all files that reference a particular `\\#include'
54 file throughout a huge source hierarchy, search for all the
55 memos containing references to a project, or automatically
56 invoke an editor on all files containing references to some
57 function or variable. Anyone with a large software project to
58 maintain, or a large set of text files to organize, can benefit
59 from the ID utilities.
60
61 Although the name `ID' is short for `identifier', the ID
62 utilities handle more than just identifiers; they also treat
63 other kinds of tokens, most notably numeric constants, and the
64 contents of certain character strings.")
65 (license gpl3+)))