Mercurial > emacs
comparison lisp/info-xref.el @ 54544:81243b364a79
Fix commentary.
author | Juri Linkov <juri@jurta.org> |
---|---|
date | Thu, 25 Mar 2004 10:35:07 +0000 |
parents | 5766a12d96ac |
children | 6fb026ad601f |
comparison
equal
deleted
inserted
replaced
54543:5766a12d96ac | 54544:81243b364a79 |
---|---|
1 ;;; info-xref.el --- check external references in an Info document. | 1 ;;; info-xref.el --- check external references in an Info document |
2 | 2 |
3 ;; Copyright 2003, 2004 Free Software Foundation, Inc | 3 ;; Copyright (C) 2003, 2004 Free Software Foundation, Inc. |
4 ;; | 4 |
5 ;; Author: Kevin Ryde <user42@zip.com.au> | 5 ;; Author: Kevin Ryde <user42@zip.com.au> |
6 ;; Keywords: docs | 6 ;; Keywords: docs |
7 ;; | 7 |
8 ;; info-xref.el is free software; you can redistribute it and/or modify | 8 ;; This file is part of GNU Emacs. |
9 ;; it under the terms of the GNU General Public License as published by the | 9 |
10 ;; Free Software Foundation; either version 2, or (at your option) any later | 10 ;; GNU Emacs is free software; you can redistribute it and/or modify |
11 ;; version. | 11 ;; it under the terms of the GNU General Public License as published by |
12 ;; | 12 ;; the Free Software Foundation; either version 2, or (at your option) |
13 ;; info-xref.el is distributed in the hope that it will be useful, but | 13 ;; any later version. |
14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | 14 |
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General | 15 ;; GNU Emacs is distributed in the hope that it will be useful, |
16 ;; Public License for more details. | 16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
17 ;; | 17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
18 ;; You can get a copy of the GNU General Public License online at | 18 ;; GNU General Public License for more details. |
19 ;; http://www.gnu.org/licenses/gpl.txt, or you should have one in the file | 19 |
20 ;; COPYING which comes with GNU Emacs and other GNU programs. Failing that, | 20 ;; You should have received a copy of the GNU General Public License |
21 ;; write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | 21 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
22 ;; Boston, MA 02111-1307, USA. | 23 ;; Boston, MA 02111-1307, USA. |
23 | |
24 | 24 |
25 ;;; Commentary: | 25 ;;; Commentary: |
26 | 26 |
27 ;; This file implements some simple checking of external cross references in | 27 ;; This file implements some simple checking of external cross references in |
28 ;; info files, by attempting to visit the nodes specified. | 28 ;; info files, by attempting to visit the nodes specified. |
58 ;; suffix (eg. this is usual for the emacs manuals). One consequence of | 58 ;; suffix (eg. this is usual for the emacs manuals). One consequence of |
59 ;; this is that if for instance there's a source code directory in | 59 ;; this is that if for instance there's a source code directory in |
60 ;; `Info-directory-list' then a lot of extraneous files might be read, which | 60 ;; `Info-directory-list' then a lot of extraneous files might be read, which |
61 ;; will be time consuming but should be harmless. | 61 ;; will be time consuming but should be harmless. |
62 ;; | 62 ;; |
63 ;; | |
64 ;; `M-x info-xref-check-all-custom' is a related command, it goes through | 63 ;; `M-x info-xref-check-all-custom' is a related command, it goes through |
65 ;; all info document references in customizable variables, checking them | 64 ;; all info document references in customizable variables, checking them |
66 ;; like info file cross references. | 65 ;; like info file cross references. |
67 | |
68 | |
69 ;;; Install: | |
70 | |
71 ;; Put info-xref.el somewhere in your `load-path', and in your .emacs put | |
72 ;; | |
73 ;; (autoload 'info-xref-check "info-xref" nil t) | |
74 ;; (autoload 'info-xref-check-all "info-xref" nil t) | |
75 ;; | |
76 ;; then | |
77 ;; | |
78 ;; M-x info-xref-check | |
79 ;; | |
80 ;; and enter an info file name. | |
81 | |
82 | |
83 ;;; Emacsen: | |
84 | |
85 ;; Designed for use with GNU Emacs 21. | |
86 | |
87 | |
88 ;;; History: | |
89 | |
90 ;; Version 1 - the first version. | |
91 | |
92 | 66 |
93 ;;; Code: | 67 ;;; Code: |
94 | 68 |
95 (require 'info) | 69 (require 'info) |
96 | 70 |