[Top][All Lists]

[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.
+* 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
+@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' 
 *** 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,
+*** 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

reply via email to

[Prev in Thread] Current Thread [Next in Thread]