Merge commit 'e93367512080e540dc5dd126dfcb38b4a5e9415b' from diff-hl

[gnu-emacs-elpa] / packages / ggtags / README.rst

diff --git a/packages/ggtags/README.rst b/packages/ggtags/README.rst
index fc0b9bb3545835266a65de02119c91b964307749..eda042724f24c1c4ca366f3acdba7ef2657a524a 100644 (file)
--- a/packages/ggtags/README.rst
+++ b/packages/ggtags/README.rst
@@ -4,7 +4,7 @@
 
 This package is part of `GNU ELPA <http://elpa.gnu.org>`_ (``M-x
 list-packages``) and is also available on `MELPA
-<http://melpa.milkbox.net/#/ggtags>`_.
+<https://melpa.org/#/ggtags>`_.
 
 The goal is to make working with GNU Global in Emacs as effortlessly
 and intuitively as possible and to integrate tightly with standard
@@ -61,10 +61,11 @@ Install Global and plugins
      ./configure --prefix=<PREFIX> --with-exuberant-ctags=/usr/local/bin/ctags
      make && make install
 
-   The executable ``ctags`` is unfortunately named because ``emacs`` also
-   includes a command of the same name. So make sure it is from
-   http://ctags.sourceforge.net. See ``plugin-factory/README`` in GNU
-   Global source for further information.
+   The executable ``ctags`` is unfortunately named because ``emacs``
+   also includes a command of the same name. So make sure it is from
+   http://ctags.sourceforge.net. See ``plugin-factory/PLUGIN_HOWTO``
+   (``plugin-factory/README`` for Global < 6.5) in GNU Global
+   source for further information.
 
 2. Install ``pygments`` plugin
 
@@ -194,6 +195,10 @@ turned on to facilitate locating the right match.
 
    Move to previous file.
 
+``M-=``
+
+   Move to the file where navigation session starts.
+
 ``M-<``
 
    Move to the first match.
@@ -218,7 +223,7 @@ turned on to facilitate locating the right match.
 Miscellaneous commands
 ++++++++++++++++++++++
 
-Commands are avaiable from the ``Ggtags`` menu in ``ggtags-mode``.
+Commands are available from the ``Ggtags`` menu in ``ggtags-mode``.
 
 ggtags-prev-mark
 
@@ -260,18 +265,22 @@ ggtags-delete-tags
 
    Delete the GTAGS, GRTAGS, GPATH and ID files of current project.
 
+ggtags-explain-tags
+
+  Explain how each file is indexed in current project.
+
 ggtags-browse-file-as-hypertext
 
    Use ``htags`` to generate HTML of the source tree. This allows
-   browsing the porject in a browser with cross-references.
+   browsing the project in a browser with cross-references.
 
 Integration with other packages
 +++++++++++++++++++++++++++++++
 
 * eldoc
 
-  ``Eldoc`` support can be enabled by, for example, setting this in
-  the desired major mode with:
+  ``Eldoc`` support is set up by default on emacs 24.4+. For older
+  versions set, for example, in the desired major mode:
 
   ::
 
@@ -304,12 +313,46 @@ Integration with other packages
 NEWS
 ~~~~
 
+[2015-12-15 Tue] 0.8.11
++++++++++++++++++++++++
+
+#. ``ggtags-highlight-tag-delay`` is renamed to
+   ``ggtags-highlight-tag``.
+#. Tag highlighting can be disabled by setting
+   ``ggtags-highlight-tag`` to nil.
+
+[2015-06-12 Fri] 0.8.10
++++++++++++++++++++++++
+
+#. Tags update on save is configurable by ``ggtags-update-on-save``.
+#. New command ``ggtags-explain-tags`` to explain how each file is
+   indexed in current project. Global 6.4+ required.
+#. New user option ``ggtags-sort-by-nearness`` that sorts matched tags
+   by nearness to current directory.
+
+[2015-01-16 Fri] 0.8.9
+++++++++++++++++++++++
+
+#. ``ggtags-visit-project-root`` can visit past projects.
+#. ``eldoc`` support enabled for emacs 24.4+.
+
+[2014-12-03 Wed] 0.8.8
+++++++++++++++++++++++
+
+#. Command ``ggtags-update-tags`` now runs in the background for large
+   projects (per ``ggtags-oversize-limit``) without blocking emacs.
+
+[2014-11-10 Mon] 0.8.7
+++++++++++++++++++++++
+
+#. New navigation command ``ggtags-navigation-start-file``.
+#. New variable ``ggtags-use-sqlite3`` to enable sqlite3 storage.
+
 [2014-09-12 Fri] 0.8.6
 ++++++++++++++++++++++
 
 #. ``ggtags-show-definition`` shows definition with font locking.
 
-
 [2014-06-22 Sun] 0.8.5
 ++++++++++++++++++++++