diff options
| author | Lars Ingebrigtsen | 2016-04-27 20:40:59 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2016-05-01 19:27:07 +0200 |
| commit | 9bd2af866badb59801dd3a81ff63a42a9f8ad97f (patch) | |
| tree | 533dcd0b4f67457069b272d1a386bec69cb93e82 | |
| parent | d8affa3dc5267c5da120ac09e14a81e0afed8fe8 (diff) | |
| download | emacs-9bd2af866badb59801dd3a81ff63a42a9f8ad97f.tar.gz emacs-9bd2af866badb59801dd3a81ff63a42a9f8ad97f.zip | |
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)
| -rw-r--r-- | lisp/progmodes/compile.el | 6 |
1 files changed, 4 insertions, 2 deletions
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). | |||
| 2753 | In the former case, FILENAME may be relative or absolute. | 2753 | In the former case, FILENAME may be relative or absolute. |
| 2754 | 2754 | ||
| 2755 | The file-structure looks like this: | 2755 | The file-structure looks like this: |
| 2756 | ((FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)" | 2756 | ((FILENAME [TRUE-DIRNAME]) FMT ...) |
| 2757 | |||
| 2758 | TRUE-DIRNAME is the `file-truename' of DIRNAME, if given." | ||
| 2757 | (or (gethash file compilation-locs) | 2759 | (or (gethash file compilation-locs) |
| 2758 | ;; File was not previously encountered, at least not in the form passed. | 2760 | ;; File was not previously encountered, at least not in the form passed. |
| 2759 | ;; Let's normalize it and look again. | 2761 | ;; Let's normalize it and look again. |
| @@ -2808,7 +2810,7 @@ The file-structure looks like this: | |||
| 2808 | (let ((fs (compilation-get-file-structure file))) | 2810 | (let ((fs (compilation-get-file-structure file))) |
| 2809 | (cl-assert (eq fs (gethash file compilation-locs))) | 2811 | (cl-assert (eq fs (gethash file compilation-locs))) |
| 2810 | (cl-assert (eq fs (gethash (cons (caar fs) (cadr (car fs))) | 2812 | (cl-assert (eq fs (gethash (cons (caar fs) (cadr (car fs))) |
| 2811 | compilation-locs))) | 2813 | compilation-locs))) |
| 2812 | (maphash (lambda (k v) | 2814 | (maphash (lambda (k v) |
| 2813 | (if (eq v fs) (remhash k compilation-locs))) | 2815 | (if (eq v fs) (remhash k compilation-locs))) |
| 2814 | compilation-locs))) | 2816 | compilation-locs))) |