[elpa] scratch/add-vdiff 6ca5943 4/4: Merge commit '1965a5ad25749c0102018c420e4abcfd7567b0bd' into scratch/add-vdiff

[Justin Burkett]

branch: scratch/add-vdiff
commit 6ca59439afc4490560eb74f1ee9fcc8fcfa6a2cc
Merge: 819ea4b 1965a5a
Author: Justin Burkett <address@hidden>
Commit: Justin Burkett <address@hidden>

    Merge commit '1965a5ad25749c0102018c420e4abcfd7567b0bd' into 
scratch/add-vdiff
---
 packages/vdiff/README.org     | 36 +++++++++++++++++----------------
 packages/vdiff/vdiff-magit.el |  2 +-
 packages/vdiff/vdiff.el       | 46 +++++++++++++++++++++++--------------------
 3 files changed, 45 insertions(+), 39 deletions(-)

diff --git a/packages/vdiff/README.org b/packages/vdiff/README.org
index 8fc21a2..42e2463 100644
--- a/packages/vdiff/README.org
+++ b/packages/vdiff/README.org
@@ -16,23 +16,25 @@ A tool like vimdiff for Emacs
 
 ** Introduction
 
-vdiff is a diff tool for Emacs that is made to behave like vimdiff, meaning 
diff
-information is displayed in buffers as you edit them. There are commands for
-cycling through the hunks detected by =diff= and applying changes from one
-buffer to the other. The main features are
-
-  1. Synchronized scrolling of the buffers with lines matching between the two
-  2. Commands to transmit (send/receive) hunks between buffers
-  3. Automatic folding of lines that are unchanged in both buffers
-  4. Commands to jump easily between hunks
-  5. Everything done through overlays, meaning vdiff doesn't alter the actual
-     text in the buffer (unless you are transmit changes of course)
-  6. Unlike ediff, remain in buffers instead of having to use a third "control
-     buffer"
-  7. Cool hydra (see below)
-
-vdiff has not been extensively tested yet, so please report any issues you
-find. Contributions and suggestions are very welcome.
+vdiff compares two or three buffers on the basis of the output from the diff
+tool. The buffers are kept synchronized so that as you move through one of the
+buffers the top of the active buffer aligns with the corresponding top of the
+other buffer(s). This is similar to how ediff works, but in ediff you use a
+third "control buffer" to move through the diffed buffers. The key difference 
is
+that in vdiff you are meant to actively edit one of the buffers and the display
+will update automatically for the other buffer. Similar to ediff, vdiff 
provides
+commands to "send" and "receive" hunks from one buffer to the other as well as
+commands to traverse the diff hunks, which are useful if you are trying to 
merge
+changes. In contrast to ediff, vdiff also provides folding capabilities to fold
+sections of the buffers that don't contain changes. This folding occurs
+automatically. Finally, you are encouraged to bind a key to `vdiff-hydra/body',
+which will use hydra.el (in ELPA) to create a convenient transient keymap
+containing most of the useful vdiff commands.
+
+This functionality is all inspired by (but not equivalent to) the vimdiff tool
+from vim.
+
+Contributions and suggestions are very welcome.
 
 ** Recent (Significant) Changes
    - [2017-02-01] Added magit integration functions in =vdiff-magit.el=. See 
[[#magit-integration][Magit integration]].
diff --git a/packages/vdiff/vdiff-magit.el b/packages/vdiff/vdiff-magit.el
index aa9190b..241df34 100644
--- a/packages/vdiff/vdiff-magit.el
+++ b/packages/vdiff/vdiff-magit.el
@@ -1,6 +1,6 @@
 ;;; vdiff-magit.el --- magit integration for vdiff -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2016-2017 Justin Burkett
+;; Copyright (C) 2017 Free Software Foundation, Inc.
 
 ;; Author: Justin Burkett <address@hidden>
 
diff --git a/packages/vdiff/vdiff.el b/packages/vdiff/vdiff.el
index b2c5e91..ba26feb 100644
--- a/packages/vdiff/vdiff.el
+++ b/packages/vdiff/vdiff.el
@@ -1,10 +1,11 @@
 ;;; vdiff.el --- A diff tool similar to  vimdiff -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2016 Justin Burkett
+;; Copyright (C) 2017  Free Software Foundation, Inc.
 
 ;; Author: Justin Burkett <address@hidden>
+;; Maintainer: Justin Burkett <address@hidden>
 ;; URL: https://github.com/justbur/emacs-vdiff
-;; Version: 0.1
+;; Version: 0.2
 ;; Keywords: diff
 ;; Package-Requires: ((emacs "24.4") (hydra "0.13.0"))
 
@@ -21,29 +22,32 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+;;; News:
+
+;; Version 0.2
+;;   * First ELPA Release
+
 ;;; Commentary:
 
 ;; A tool like vimdiff for Emacs
 
-;; * Introduction
-
-;; vdiff is a diff tool for Emacs that is made to behave like vimdiff, meaning
-;; diff information is displayed in buffers as you edit them. There are 
commands
-;; for cycling through the hunks detected by =diff= and applying changes from
-;; one buffer to the other. The main features are
-
-;;   1. Synchronized scrolling of the buffers with lines matching between the
-;;      two
-;;   2. Commands to transmit (send/receive) changes between buffers
-;;   3. Automatic folding of lines that are unchanged in both buffers
-;;   4. Commands to jump easily between hunks
-;;   5. Everything done through overlays, meaning vdiff doesn't alter the 
actual
-;;      text in the buffer (unless you are transmit changes of course)
-;;   6. Unlike ediff, remain in buffers instead of having to use a third 
"control
-;;      buffer"
-;;   7. Cool hydra
-
-;; Contributions and suggestions are very welcome.
+;; vdiff compares two or three buffers on the basis of the output from the diff
+;; tool. The buffers are kept synchronized so that as you move through one of
+;; the buffers the top of the active buffer aligns with the corresponding top 
of
+;; the other buffer(s). This is similar to how ediff works, but in ediff you 
use
+;; a third "control buffer" to move through the diffed buffers. The key
+;; difference is that in vdiff you are meant to actively edit one of the 
buffers
+;; and the display will update automatically for the other buffer. Similar to
+;; ediff, vdiff provides commands to "send" and "receive" hunks from one buffer
+;; to the other as well as commands to traverse the diff hunks, which are 
useful
+;; if you are trying to merge changes. In contrast to ediff, vdiff also 
provides
+;; folding capabilities to fold sections of the buffers that don't contain
+;; changes. This folding occurs automatically. Finally, you are encouraged to
+;; bind a key to `vdiff-hydra/body', which will use hydra.el (in ELPA) to 
create
+;; a convenient transient keymap containing most of the useful vdiff commands.
+
+;; This functionality is all inspired by (but not equivalent to) the vimdiff
+;; tool from vim.
 
 ;; See https://github.com/justbur/emacs-vdiff for more information