mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-26 07:33:47 +00:00
Code Issues Releases Activity

Improve documentation of 'project-mode-line'

Browse Source 
* etc/NEWS:
* doc/emacs/maintaining.texi (Projects):
* lisp/progmodes/project.el (project-mode-line): Improve the
documentation of 'project-mode-line'.  (Bug#66317)
This commit is contained in:
Eli Zaretskii 2023-10-10 14:46:08 +03:00
parent 60e3071d57
commit d51f3165f7
3 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/emacs/maintaining.texi
View File

@ -1743,6 +1743,14 @@ project. Also, the VC-aware Project back-end considers ``untracked''
files by default. That behavior is controllable with the variable
@code{project-vc-include-untracked}.
@cindex current project name on mode line
@defopt project-mode-line
If this user option is non-@code{nil}, Emacs displays the name of the
current project (if any) on the mode line; clicking @kbd{mouse-1} on
the project name pops up the menu with the project-related commands.
The default value is @code{nil}.
@end defopt
@menu
* Project File Commands:: Commands for handling project files.
* Project Buffer Commands:: Commands for handling project buffers.

5
etc/NEWS
View File

@ -890,8 +890,9 @@ showcases all their customization options.
** Project
*** New user option 'project-mode-line'.
When non-nil, display the name of the current project on
the mode line. Clicking mouse-1 pops up the project menu.
When non-nil, display the name of the current project on the mode
line. Clicking 'mouse-1' on the project name pops up the project
menu. The default value is nil.
*** New user option 'project-file-history-behavior'.
Customizing it to 'relativize' makes commands like 'project-find-file'

5
lisp/progmodes/project.el
View File

@ -2014,9 +2014,10 @@ would otherwise have the same name."
;;;###autoload
(defcustom project-mode-line nil
"Show the current project name with the menu on the mode line.
"Whether to show current project name and Project menu on the mode line.
This feature requires the presence of the following item in
`mode-line-format': `(project-mode-line project-mode-line-format)'."
`mode-line-format': `(project-mode-line project-mode-line-format)'; it
is part of the default mode line beginning with Emacs 30."
:type 'boolean
:group 'project
:version "30.1")