[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
feature/project-switching 0db801a 11/15: Update the Emacs manual with re
From: |
Simen Heggestøyl |
Subject: |
feature/project-switching 0db801a 11/15: Update the Emacs manual with recent project.el changes |
Date: |
Tue, 26 May 2020 11:43:19 -0400 (EDT) |
branch: feature/project-switching
commit 0db801a3adf8e8584c9b071764200259336a8434
Author: Simen Heggestøyl <address@hidden>
Commit: Simen Heggestøyl <address@hidden>
Update the Emacs manual with recent project.el changes
* doc/emacs/maintaining.texi (Projects): Add a menu.
(Project File Commands): New subsection describing project file
commands (moved here from 'Working with Projects'). Describe the new
commands 'project-dired' and 'project-eshell'.
(Switching Projects): New subsection.
* etc/NEWS: Mention project.el changes.
---
doc/emacs/maintaining.texi | 34 +++++++++++++++++++++++++++++++++-
etc/NEWS | 13 +++++++++++++
2 files changed, 46 insertions(+), 1 deletion(-)
diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index ebcdddf..adaafdb 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -1656,8 +1656,16 @@ support additional types of projects.
the project back-end. For example, the VC back-end doesn't consider
``ignored'' files (@pxref{VC Ignore}) to be part of the project.
+@menu
+* Project File Commands:: Commands for handling project files.
+* Switching Projects:: Switching between projects.
+@end menu
+
+@node Project File Commands
+@subsection Project File Commands
+
Emacs provides commands for handling project files conveniently.
-This section describes these commands.
+This subsection describes these commands.
@cindex current project
All of the commands described here share the notion of the
@@ -1705,6 +1713,30 @@ Replace}), and continues to the next match after you
respond. If your
response causes Emacs to exit the query-replace loop, you can later
continue with @w{@kbd{M-x fileloop-continue @key{RET}}}.
+@findex project-dired
+ The command @code{project-dired} opens a Dired buffer
+(@pxref{Dired}) listing the files in the current project's root
+directory.
+
+@findex project-eshell
+ The command @code{project-eshell} starts an Eshell session in a new
+buffer with the current project's root as the working directory.
+@xref{Top,Eshell,Eshell, eshell, Eshell: The Emacs Shell}.
+
+@node Switching Projects
+@subsection Switching Projects
+
+ Commands that operate on project files (@pxref{Project File
+Commands}) will conveniently prompt you for a project directory when
+no project is current. When a project is current but you want to
+operate on a different project, the command
+@code{project-switch-project} can be used.
+
+ This command prompts you for a new project directory, and then
+displays a menu of commands avilable for operating on the chosen
+project. The variable @code{project-switch-commands} controls which
+commands are avilable in the menu, and by which keys they are invoked.
+
@node Change Log
@section Change Logs
diff --git a/etc/NEWS b/etc/NEWS
index e97755a..7424507 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -389,6 +389,19 @@ information, see the related entry about 'shr-browse-url'
above.
*** New user option 'project-vc-merge-submodules'.
+*** Previously used project directories are now are now completed by
+all commands that prompt for a project directory.
+
++++
+*** New commands 'project-dired' and 'project-eshell'.
+These commands run Dired and Eshell in a project's root directory,
+respectively.
+
++++
+*** New command 'project-switch-project'.
+This command lets you "switch" to another project by running a project
+command chosen from a dispatch menu.
+
** json.el
---
- branch feature/project-switching created (now 449810b), Simen Heggestøyl, 2020/05/26
- feature/project-switching afb7602 01/15: Add project switching functionality, Simen Heggestøyl, 2020/05/26
- feature/project-switching 9422fb5 03/15: Improve project name completion, Simen Heggestøyl, 2020/05/26
- feature/project-switching c8cca68 04/15: Use an alist instead of a keymap, Simen Heggestøyl, 2020/05/26
- feature/project-switching afb96da 05/15: Move project-dired and project-eshell higher, Simen Heggestøyl, 2020/05/26
- feature/project-switching 02e1ee9 06/15: Integrate project-switch-project with project-find-regexp, Simen Heggestøyl, 2020/05/26
- feature/project-switching 46bb2cb 07/15: Change dispatch binding of 'project-find-regexp', Simen Heggestøyl, 2020/05/26
- feature/project-switching 0db801a 11/15: Update the Emacs manual with recent project.el changes,
Simen Heggestøyl <=
- feature/project-switching e37e6c8 13/15: Some copy edits, Simen Heggestøyl, 2020/05/26
- feature/project-switching 9f88356 02/15: Simplify a little, and avoid duplicate commands, Simen Heggestøyl, 2020/05/26
- feature/project-switching c6f56bd 08/15: Turn project switch menu var into a public alist, Simen Heggestøyl, 2020/05/26
- feature/project-switching 7082468 10/15: Rename 'project-switch-menu' to 'project-switch-commands', Simen Heggestøyl, 2020/05/26
- feature/project-switching 0b057ca 12/15: Teach project-current to inhibit the prompt, Simen Heggestøyl, 2020/05/26
- feature/project-switching 449810b 15/15: Avoid adding the empty string to the project list, Simen Heggestøyl, 2020/05/26
- feature/project-switching c6e80fd 09/15: Simplify 'project--keymap-prompt' a bit, Simen Heggestøyl, 2020/05/26
- feature/project-switching 5a48ede 14/15: Adapt project functions to the new 'project-root', Simen Heggestøyl, 2020/05/26