Commits

Didier Verna committed cb3878b

Update the Quick Start chapter.

doc/ChangeLog addition:

2011-12-15 Didier Verna <didier@xemacs.org>

* patcher.texi (Quick Start):
* patcher.texi (Setting up Patcher):
* patcher.texi (Calling Patcher):
* patcher.texi (Committing the Patch): Update.

Comments (0)

Files changed (1)

 @c Author:        Didier Verna <didier@xemacs.org>
 @c Maintainer:    Didier Verna <didier@xemacs.org>
 @c Created:       Sun Apr 21 21:34:06 2002
-@c Last Revision: Thu Dec 15 17:30:22 2011
+@c Last Revision: Thu Dec 15 17:51:36 2011
 
 @c This file is part of Patcher.
 
 @node Quick Start, User Manual, Installation, Top
 @chapter Quick Start
 
-In this chapter, we quickly setup the basic Patcher configuration for
-hacking on XEmacs. Adapt the example as you wish. Let's make some
-assumptions first:
+This chapter demonstrates the use of Patcher through a quick and basic
+setup. Adapt the example as you wish. Let's make some assumptions first:
 
 @itemize @bullet
 @item
 You have the @file{add-log} library from the @file{xemacs-base} package,
 version 2.21 or later, installed on your system.
 @item
-You're using XEmacs 21.5 from the Mercurial repository.
+You're working on a Git project called SuperProj.
 @item
-Your local copy of the repository is located in
-@file{/usr/local/src/xemacs/21.5/}.
+Your local clone of the Git repository is located in
+@file{/home/me/superproj}.
 @item
-Your local copy of the repository is up-to-date, but you've done some
-hacking in the sources that you'd like to submit.
+You have commit access to this project.
+@item
+There is a mailing list for developers at
+@email{superproj-devel@@superproj.org}.
+@item
+Your repository is up-to-date, but you've done some hacking in the
+sources that you'd like to commit.
 @item
 Since you're lazy, you didn't write the ChangeLog entries yet.
 @end itemize
 @node Setting up Patcher, Calling Patcher, Quick Start, Quick Start
 @section Setting up Patcher
 
-The first thing to do is to make patcher aware of your ``XEmacs''
+The first thing to do is to make patcher aware of your ``SuperProj''
 project. Put this in your @file{.emacs} file:
 
 @lisp
 (setq patcher-projects
-      '(("XEmacs 21.5" "/usr/local/src/xemacs/21.5"
-         :to-address "xemacs-patches@@xemacs.org"
-         :themes (mercurial))))
+        '(("SuperProj" "/home/me/superproj"
+        :to-address "superproj-devel@@superproj.org"
+        :commit-privilege t
+        :themes (git))))
 @end lisp
 
 @vindex patcher-projects
 you store information about the projects you want to manage with
 Patcher. It is actually a list of what's called @dfn{project
 descriptors}. Here's the meaning of the only project descriptor we have
-in the example above: we have a project named ``XEmacs'', located in
-@file{/usr/local/src/xemacs/21.5/} and for which emails should be sent
-to @email{xemacs-patches@@xemacs.org}. In addition to that, this project
-is handled by Mercurial.
+in the example above: we have a project named ``SuperProj'', located in
+@file{/home/me/superproj} and for which emails should be sent to
+@email{superproj-devel@@superproj.org}. In addition to that, this
+project is handled by Git.
 
 Note the particular syntax for specifying the mailing address. This is
 what's called a @dfn{project option}. Contrary to the project's name and
 appear in any order. Note also that we have used a @code{:themes} option
 for specifying the revision control system in use. A ``theme'' is a set
 of options with particular values. Patcher happens to come with some
-predefined themes, including one for Mercurial.
+predefined themes, including one for Git.
 
 
 @c Calling Patcher ====================================================
 
 @findex patcher-mail
 First, you're prompted (with completion) for a project name (the first
-element of each project descriptor, remember?). We currently only have
-an ``XEmacs'' project, so hitting @kbd{TAB} will directly fill the
+element of each project descriptor, remember?). We currently only have a
+``SuperProj'' project, so hitting @kbd{TAB} will directly fill the
 minibuffer in with this only choice. Then, you're prompted for a subject
 line that will be used in the mail. Say something sensible here.
 
 subject line now reads ``[PATCH] something sensible here''.
 @item
 Patcher now builds the patch. The command used to do this is specified
-in the Mercurial theme, but it is a project option so it can be changed.
-Upon successful completion of this command (we assume that's indeed the
+in the Git theme, but it is a project option so it can be changed. Upon
+successful completion of this command (we assume that's indeed the
 case), the patch is inserted into the mail buffer. Some information
 about the patch is provided just above it (the command used, the files
 affected and so on).
 another buffer called the ``commit command'' buffer. This buffer lets
 you modify, or at least check the commit command to use.
 
-The default commit command is specified in the Mercurial theme, but it
-is of course a project option so it can be changed. Note that Patcher
-stores the log message in a temporary file and uses the
-@option{--logfile} option of the Mercurial @samp{commit} command.
-Finally, note that Patcher has automatically appended the affected
-ChangeLog files to the commit command.
+The default commit command is specified in the Git theme, but it is of
+course a project option so it can be changed. Note that Patcher stores
+the log message in a temporary file and uses the @option{-F} option of
+the Git @samp{commit} command. Finally, note that Patcher has
+automatically appended the affected ChangeLog files to the commit
+command.
 
 @findex patcher-cmtcmd commit
 @kindex C-c C-p c