Commit f441be5b authored by Juanma Barranquero's avatar Juanma Barranquero
Browse files

(compilation-find-file, compilation-handle-exit): Fix typos in docstrings.

(compilation-search-path, compilation-buffer-name-function): Doc fixes.
(compilation-finish-function): Fix typo in obsolescence declaration.
parent b1b15f76
2007-06-04 Juanma Barranquero <lekktu@gmail.com>
* progmodes/compile.el (compilation-find-file, compilation-handle-exit):
Fix typos in docstrings.
(compilation-search-path, compilation-buffer-name-function): Doc fixes.
(compilation-finish-function): Fix typo in obsolescence declaration.
2007-06-03 Sam Steingold <sds@gnu.org> 2007-06-03 Sam Steingold <sds@gnu.org>
Add TIMESTAMP to LOC to handle "incremental compilation", e.g., Add TIMESTAMP to LOC to handle "incremental compilation", e.g.,
......
...@@ -120,7 +120,7 @@ bound to the compilation buffer and window, respectively.") ...@@ -120,7 +120,7 @@ bound to the compilation buffer and window, respectively.")
"Function to compute the name of a compilation buffer. "Function to compute the name of a compilation buffer.
The function receives one argument, the name of the major mode of the The function receives one argument, the name of the major mode of the
compilation buffer. It should return a string. compilation buffer. It should return a string.
nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.") If nil, compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
;;;###autoload ;;;###autoload
(defvar compilation-finish-function nil (defvar compilation-finish-function nil
...@@ -129,7 +129,7 @@ It is called with two arguments: the compilation buffer, and a string ...@@ -129,7 +129,7 @@ It is called with two arguments: the compilation buffer, and a string
describing how the process finished.") describing how the process finished.")
(make-obsolete-variable 'compilation-finish-function (make-obsolete-variable 'compilation-finish-function
"Use `compilation-finish-functions', but it works a little differently." "use `compilation-finish-functions', but it works a little differently."
"22.1") "22.1")
;;;###autoload ;;;###autoload
...@@ -469,7 +469,7 @@ Otherwise, it saves all modified buffers without asking." ...@@ -469,7 +469,7 @@ Otherwise, it saves all modified buffers without asking."
(defcustom compilation-search-path '(nil) (defcustom compilation-search-path '(nil)
"*List of directories to search for source files named in error messages. "*List of directories to search for source files named in error messages.
Elements should be directory names, not file names of directories. Elements should be directory names, not file names of directories.
nil as an element means to try the default directory." The value nil as an element means to try the default directory."
:type '(repeat (choice (const :tag "Default" nil) :type '(repeat (choice (const :tag "Default" nil)
(string :tag "Directory"))) (string :tag "Directory")))
:group 'compilation) :group 'compilation)
...@@ -1422,7 +1422,7 @@ Turning the mode on runs the normal hook `compilation-minor-mode-hook'." ...@@ -1422,7 +1422,7 @@ Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
(font-lock-fontify-buffer))) (font-lock-fontify-buffer)))
(defun compilation-handle-exit (process-status exit-status msg) (defun compilation-handle-exit (process-status exit-status msg)
"Write MSG in the current buffer and hack its mode-line-process." "Write MSG in the current buffer and hack its `mode-line-process'."
(let ((inhibit-read-only t) (let ((inhibit-read-only t)
(status (if compilation-exit-message-function (status (if compilation-exit-message-function
(funcall compilation-exit-message-function (funcall compilation-exit-message-function
...@@ -1836,8 +1836,8 @@ and overlay is highlighted between MK and END-MK." ...@@ -1836,8 +1836,8 @@ and overlay is highlighted between MK and END-MK."
Search the directories in `compilation-search-path'. Search the directories in `compilation-search-path'.
A nil in `compilation-search-path' means to try the A nil in `compilation-search-path' means to try the
\"current\" directory, which is passed in DIRECTORY. \"current\" directory, which is passed in DIRECTORY.
If DIRECTORY. is relative, it is combined with `default-directory'. If DIRECTORY is relative, it is combined with `default-directory'.
If DIRECTORY. is nil, that means use `default-directory'. If DIRECTORY is nil, that means use `default-directory'.
If FILENAME is not found at all, ask the user where to find it. If FILENAME is not found at all, ask the user where to find it.
Pop up the buffer containing MARKER and scroll to MARKER if we ask the user." Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
(or formats (setq formats '("%s"))) (or formats (setq formats '("%s")))
...@@ -1878,7 +1878,7 @@ Pop up the buffer containing MARKER and scroll to MARKER if we ask the user." ...@@ -1878,7 +1878,7 @@ Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
;; restrictive otherwise, since it also prevents the ;; restrictive otherwise, since it also prevents the
;; user from completing "fo" to "foo/" when she ;; user from completing "fo" to "foo/" when she
;; wants to enter "foo/bar". ;; wants to enter "foo/bar".
;; ;;
;; Try to make sure the user can only select ;; Try to make sure the user can only select
;; a valid answer. This predicate may be ignored, ;; a valid answer. This predicate may be ignored,
;; tho, so we still have to double-check afterwards. ;; tho, so we still have to double-check afterwards.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment