From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Wed, 27 Apr 2016 18:40:59 +0000 (+0200)
Subject: Clarify doc string of internal compilation function
X-Git-Tag: emacs-25.0.94~118
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=9bd2af866badb59801dd3a81ff63a42a9f8ad97f;p=emacs.git

Clarify doc string of internal compilation function

* lisp/progmodes/compile.el (compilation-get-file-structure):
Clarify doc string (bug#3137).

(cherry picked from commit 123191decb7428db3b32a6c01631fa755088393a)
---

diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el
index dbda8a9d5b8..f060b571b7c 100644
--- a/lisp/progmodes/compile.el
+++ b/lisp/progmodes/compile.el
@@ -2753,7 +2753,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.
@@ -2808,7 +2810,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)))