Add comment for compilation-directory-properties.

1 files changed, 4 insertions, 0 deletions

diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el
index 79a6b4b43be..457177d7c4c 100644
--- a/lisp/progmodes/compile.el
+++ b/lisp/progmodes/compile.el
@@ -514,6 +514,10 @@ Faces `compilation-error-face', `compilation-warning-face',
       (and (cdr type) (match-end (cdr type)) compilation-info-face)
       compilation-error-face))
 
+;; Internal function for calculating the text properties of a directory
+;; change message.  The directory property is important, because it is
+;; the stack of nested enter-messages.  Relative filenames on the following
+;; lines are relative to the top of the stack.
 (defun compilation-directory-properties (idx leave)
   (if leave (setq leave (match-end leave)))
   ;; find previous stack, and push onto it, or if `leave' pop it