]> code.delx.au - gnu-emacs/commitdiff
Clarify doc string of internal compilation function
authorLars Ingebrigtsen <larsi@gnus.org>
Wed, 27 Apr 2016 18:40:59 +0000 (20:40 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Wed, 27 Apr 2016 18:40:59 +0000 (20:40 +0200)
* lisp/progmodes/compile.el (compilation-get-file-structure):
Clarify doc string (bug#3137).

lisp/progmodes/compile.el

index 0160aab901c6e503b140bdda60931f2de38841ac..cc04fe946b92bf4d2b04fe92545e2cc7b43b00fd 100644 (file)
@@ -2760,7 +2760,9 @@ FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
 In the former case, FILENAME may be relative or absolute.
 
 The file-structure looks like this:
-  ((FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)"
+  ((FILENAME [TRUE-DIRNAME]) FMT ...)
+
+TRUE-DIRNAME is the `file-truename' of DIRNAME, if given."
   (or (gethash file compilation-locs)
       ;; File was not previously encountered, at least not in the form passed.
       ;; Let's normalize it and look again.
@@ -2815,7 +2817,7 @@ The file-structure looks like this:
   (let ((fs (compilation-get-file-structure file)))
     (cl-assert (eq fs (gethash file compilation-locs)))
     (cl-assert (eq fs (gethash (cons (caar fs) (cadr (car fs)))
-                            compilation-locs)))
+                               compilation-locs)))
     (maphash (lambda (k v)
                (if (eq v fs) (remhash k compilation-locs)))
              compilation-locs)))