From: Juri Linkov Date: Thu, 25 Mar 2004 10:32:33 +0000 (+0000) Subject: (info-xref-check-buffer): Report empty filename parts. X-Git-Tag: ttn-vms-21-2-B4~7115 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=0332a905d8809b9b3361abe9373d19c3e911fd5c;p=emacs.git (info-xref-check-buffer): Report empty filename parts. Remove spurious node duplicate suppression, doesn't work, not wanted. (info-xref-output): Take format style args, add "sit-for 0" to let user see the results as they progress. (info-xref-check-all-custom): New function. --- diff --git a/lisp/info-xref.el b/lisp/info-xref.el index 91c78e2a5c5..9f856d1deac 100644 --- a/lisp/info-xref.el +++ b/lisp/info-xref.el @@ -1,6 +1,6 @@ ;;; info-xref.el --- check external references in an Info document. -;; Copyright 2003 Free Software Foundation, Inc +;; Copyright 2003, 2004 Free Software Foundation, Inc ;; ;; Author: Kevin Ryde ;; Keywords: docs @@ -59,6 +59,11 @@ ;; this is that if for instance there's a source code directory in ;; `Info-directory-list' then a lot of extraneous files might be read, which ;; will be time consuming but should be harmless. +;; +;; +;; `M-x info-xref-check-all-custom' is a related command, it goes through +;; all info document references in customizable variables, checking them +;; like info file cross references. ;;; Install: @@ -204,32 +209,37 @@ should open up the purported top file and see what subfiles it says." This should be the raw file contents, not `Info-mode'." (goto-char (point-min)) (while (re-search-forward - "\\*[Nn]ote[ \n\t]+[^:]*:[ \n\t]+\\(\\(([^)]+)\\)[^.,]+\\)[.,]" + "\\*[Nn]ote[ \n\t]+[^:]*:[ \n\t]+\\(\\(([^)]*)\\)[^.,]+\\)[.,]" nil t) (let* ((file (match-string 2)) (node ;; Canonicalize spaces: we could use "[\t\n ]+" but ;; we try to avoid uselessly replacing " " with " ". (replace-regexp-in-string "[\t\n][\t\n ]*\\| [\t\n ]+" " " (match-string 1) t t))) - ;; see if the file exists, if we haven't tried it before - (unless (assoc file info-xref-xfile-alist) - (let ((found (info-xref-goto-node-p file))) - (push (cons file found) info-xref-xfile-alist) - (unless found - (info-xref-output (format "Not available to check: %s\n" file))))) - ;; if the file exists, try the node, if we haven't before - (when (cdr (assoc file info-xref-xfile-alist)) - (unless (assoc node info-xref-xfile-alist) + (if (string-equal "()" file) + (info-xref-output "Empty filename part: %s\n" node) + ;; see if the file exists, if we haven't tried it before + (unless (assoc file info-xref-xfile-alist) + (let ((found (info-xref-goto-node-p file))) + (push (cons file found) info-xref-xfile-alist) + (unless found + (info-xref-output "Not available to check: %s\n" file)))) + ;; if the file exists, try the node + (when (cdr (assoc file info-xref-xfile-alist)) (if (info-xref-goto-node-p node) (setq info-xref-good (1+ info-xref-good)) (setq info-xref-bad (1+ info-xref-bad)) - (info-xref-output (format "No such node: %s\n" node)))))))) + (info-xref-output "No such node: %s\n" node))))))) -(defun info-xref-output (str) - "Emit STR as an info-xref result message." +(defun info-xref-output (str &rest args) + "Emit a `format'-ed message STR+ARGS to the info-xref output buffer." (with-current-buffer info-xref-results-buffer - (insert info-xref-filename-heading str) - (setq info-xref-filename-heading ""))) + (insert info-xref-filename-heading + (apply 'format str args)) + (setq info-xref-filename-heading "") + ;; all this info-xref can be pretty slow, display now so the user can + ;; see some progress + (sit-for 0))) ;; When asking Info-goto-node to fork, *info* needs to be the current ;; buffer, otherwise it seems to clone the current buffer but then do the @@ -259,6 +269,67 @@ This should be the raw file contents, not `Info-mode'." (unless (equal (current-buffer) oldbuf) (kill-buffer (current-buffer)))))))) +;;;###autoload +(defun info-xref-check-all-custom () + "Check info references in all customize groups and variables. +`custom-manual' and `info-link' entries in the `custom-links' list are checked. + +`custom-load' autoloads for all symbols are loaded in order to get all the +link information. This will be a lot of lisp packages loaded, and can take +quite a while." + + (interactive) + (pop-to-buffer info-xref-results-buffer t) + (erase-buffer) + (let ((info-xref-filename-heading "")) + + ;; `custom-load-symbol' is not used, since it quietly ignores errors, + ;; but we want to show them (since they may mean incomplete checking). + ;; + ;; Just one pass through mapatoms is made. There shouldn't be any new + ;; custom-loads setup by packages loaded. + ;; + (info-xref-output "Loading custom-load autoloads ...\n") + (require 'cus-start) + (require 'cus-load) + (let ((viper-mode nil)) ;; tell viper.el not to ask about viperizing + (mapatoms + (lambda (symbol) + (dolist (load (get symbol 'custom-loads)) + (cond ((symbolp load) + (condition-case cause (require load) + (error + (info-xref-output "Symbol `%s': cannot require '%s: %s\n" + symbol load cause)))) + ;; skip if previously loaded + ((assoc load load-history)) + ((assoc (locate-library load) load-history)) + (t + (condition-case cause (load load) + (error + (info-xref-output "Symbol `%s': cannot load \"%s\": %s\n" + symbol load cause))))))))) + + ;; Don't bother to check whether the info file exists as opposed to just + ;; a missing node. If you have the lisp then you should have the + ;; documentation, so missing node name will be the usual fault. + ;; + (info-xref-output "\nChecking custom-links references ...\n") + (let ((good 0) + (bad 0)) + (mapatoms + (lambda (symbol) + (dolist (link (get symbol 'custom-links)) + (when (memq (car link) '(custom-manual info-link)) + (if (info-xref-goto-node-p (cadr link)) + (setq good (1+ good)) + (setq bad (1+ bad)) + ;; symbol-file gives nil for preloaded variables, would need + ;; to copy what describe-variable does to show the right place + (info-xref-output "Symbol `%s' (in %s): cannot goto node: %s\n" + symbol (symbol-file symbol) (cadr link))))))) + (info-xref-output "%d good, %d bad\n" good bad)))) + (provide 'info-xref) ;;; arch-tag: 69d4d528-69ed-4cc2-8eb4-c666a0c1d5ac