diff options
| author | Dmitry Gutov | 2020-07-12 20:55:23 +0300 |
|---|---|---|
| committer | Dmitry Gutov | 2020-07-12 20:55:23 +0300 |
| commit | 96173fbfabe538589d0ae09d78bcd11cdc74dcdb (patch) | |
| tree | 6a5de57d3af502bb1374fd6c52a6208d59f2c246 | |
| parent | 7a712578ed07f0781d7b3199ecb18258e25b553a (diff) | |
| download | emacs-96173fbfabe538589d0ae09d78bcd11cdc74dcdb.tar.gz emacs-96173fbfabe538589d0ae09d78bcd11cdc74dcdb.zip | |
; Roll back certain doc changes; clarify what "transient" is
| -rw-r--r-- | lisp/progmodes/project.el | 16 |
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. | |||
| 106 | The exact form of the project instance is up to each respective | 106 | The exact form of the project instance is up to each respective |
| 107 | function; the only practical limitation is to use values that | 107 | function; 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 |
| 109 | CL struct. For example, the default `project-try-vc' returns a | 109 | CL struct.") |
| 110 | cons 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'. |
| 118 | When no project is found in that directory, the result depends | 117 | |
| 119 | on the value of MAYBE-PROMPT: if it is nil or omitted, return nil, | 118 | When no project is found in that directory, the result depends on |
| 119 | the value of MAYBE-PROMPT: if it is nil or omitted, return nil, | ||
| 120 | else ask the user for a directory in which to look for the | 120 | else ask the user for a directory in which to look for the |
| 121 | project, and if no project is found there, return a \"transient\" | 121 | project, and if no project is found there, return a \"transient\" |
| 122 | project instance. The \"transient\" project instance is a special | 122 | project instance. |
| 123 | project object whose form is (transient DIRECTORY), and that can be | 123 | |
| 124 | used as a basis for creating a project in that directory. | 124 | The \"transient\" project instance is a special kind of value |
| 125 | which denotes a project rooted in that directory and includes all | ||
| 126 | files under it except for ones that match standard ignores. | ||
| 125 | 127 | ||
| 126 | See the doc string of `project-find-functions' for the general form | 128 | See the doc string of `project-find-functions' for the general form |
| 127 | of the project instance object." | 129 | of the project instance object." |