aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lisp/progmodes/project.el16
1 files changed, 9 insertions, 7 deletions
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index e4c07c6bedc..6902cc10e4d 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -106,8 +106,7 @@ either nil to mean that it is not applicable, or a project instance.
106The exact form of the project instance is up to each respective 106The exact form of the project instance is up to each respective
107function; the only practical limitation is to use values that 107function; the only practical limitation is to use values that
108`cl-defmethod' can dispatch on, like a cons cell, or a list, or a 108`cl-defmethod' can dispatch on, like a cons cell, or a list, or a
109CL struct. For example, the default `project-try-vc' returns a 109CL struct.")
110cons cell of the form (vc . PROJECT-ROOT-DIRECTORY).")
111 110
112(defvar project-current-inhibit-prompt nil 111(defvar project-current-inhibit-prompt nil
113 "Non-nil to skip prompting the user in `project-current'.") 112 "Non-nil to skip prompting the user in `project-current'.")
@@ -115,13 +114,16 @@ cons cell of the form (vc . PROJECT-ROOT-DIRECTORY).")
115;;;###autoload 114;;;###autoload
116(defun project-current (&optional maybe-prompt directory) 115(defun project-current (&optional maybe-prompt directory)
117 "Return the project instance in DIRECTORY, defaulting to `default-directory'. 116 "Return the project instance in DIRECTORY, defaulting to `default-directory'.
118When no project is found in that directory, the result depends 117
119on the value of MAYBE-PROMPT: if it is nil or omitted, return nil, 118When no project is found in that directory, the result depends on
119the value of MAYBE-PROMPT: if it is nil or omitted, return nil,
120else ask the user for a directory in which to look for the 120else ask the user for a directory in which to look for the
121project, and if no project is found there, return a \"transient\" 121project, and if no project is found there, return a \"transient\"
122project instance. The \"transient\" project instance is a special 122project instance.
123project object whose form is (transient DIRECTORY), and that can be 123
124used as a basis for creating a project in that directory. 124The \"transient\" project instance is a special kind of value
125which denotes a project rooted in that directory and includes all
126files under it except for ones that match standard ignores.
125 127
126See the doc string of `project-find-functions' for the general form 128See the doc string of `project-find-functions' for the general form
127of the project instance object." 129of the project instance object."