summaryrefslogtreecommitdiff
path: root/etc
diff options
context:
space:
mode:
authorChong Yidong <cyd@stupidchicken.com>2010-11-20 18:16:10 -0500
committerChong Yidong <cyd@stupidchicken.com>2010-11-20 18:16:10 -0500
commit1aaae3f39e02d2190dc59c2b56e1c0356863730c (patch)
tree39297376ad4d0f0a140b2773affa630b0ec9455f /etc
parent76dabd3729b43a7165dea82b92afc641078af881 (diff)
downloademacs-1aaae3f39e02d2190dc59c2b56e1c0356863730c.tar.gz
Document VC headers and other VC changes.
* maintaining.texi (Version Control): Say "commit", not "check in". (Version Control Systems): Simplify descriptions. (VCS Merging, VCS Changesets, VCS Repositories): New nodes, split from VCS Concepts. (VC Mode Line): Update example. (Old Revisions): Document revert-buffer for vc-diff. (Log Buffer): Promote to a subsection. Document header lines. * emacs.texi (Top): Update node listing.
Diffstat (limited to 'etc')
-rw-r--r--etc/NEWS40
1 files changed, 18 insertions, 22 deletions
diff --git a/etc/NEWS b/etc/NEWS
index 59b63440775..8e5115c6cae 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -38,39 +38,35 @@ This can be used in place of the default appt-message-warning-time.
** VC and related modes
-*** New VC commands: vc-log-incoming, vc-log-outgoing, vc-find-conflicted-file.
+*** New VC command `vc-log-incoming', bound to `C-x v I'.
+This shows a log of changes to be received with a pull operation.
+For Git, this runs "git fetch" to make the necessary data available
+locally; this requires version 1.7 or newer.
-**** vc-log-incoming for Git runs "git fetch" so that the necessary
-data is available locally.
+*** New VC command `vc-log-outgoing', bound to `C-x v O'.
+This shows a log of changes to be sent in the next commit.
-**** vc-log-incoming and vc-log-outgoing for Git require version 1.7 (or newer).
-
-*** New key bindings: C-x v I and C-x v O bound to vc-log-incoming and
-vc-log-outgoing, respectively.
+*** New VC command vc-find-conflicted-file.
++++
*** The 'g' key in VC diff, log, log-incoming and log-outgoing buffers
reruns the corresponding VC command to compute an up to date version
of the buffer.
*** vc-dir for Bzr supports viewing shelve contents and shelving snapshots.
++++
*** Special markup can be added to log-edit buffers.
-The log-edit buffers are expected to have a format similar to email messages
-with headers of the form:
- Author: <author of this change>
- Summary: <one line summary of this change>
- Fixes: <reference to the bug fixed by this change>
-Some backends handle some of those headers specially, but any unknown header
-is just left as is in the message, so it is not lost.
-
-**** vc-git handles Author: and Date:
-**** vc-hg handles Author: and Date:
-**** vc-bzr handles Author:, Date: and Fixes:
-**** vc-mtn handles Author: and Date:
-
-*** Pressing g in a *vc-diff* buffer reruns vc-diff, so it will
-produce an up to date diff.
+You can add headers specifying additional information to be supplied
+to the version control system. For example:
+
+ Author: J. R. Hacker <jrh@example.com>
+ Fixes: 4204
+ Actual text of log entry...
+Bazaar recognizes the headers "Author", "Date" and "Fixes".
+Git, Mercurial, and Monotone recognize "Author" and "Date".
+Any unknown header is left as is in the message, so it is not lost.
** Obsolete packages