Merge branch 'release/0.3.0'

Author: arnested

.gitignore

@@ -1,2 +1,6 @@
 *.elc
+drupal-mode.info
 drupal-mode-*.tar
+drupal-mode-pkg.el
+README
+.cask

CONTRIBUTING.md

@@ -0,0 +1,2 @@
+Feature requests, ideas, bug reports, and pull request are more than
+welcome!

COPYING

@@ -0,0 +1,3 @@
+(package-file "drupal-mode.el")
+
+(source marmalade)

Cask

@@ -1,22 +1,56 @@
-.PHONY: all elpa-package elpa-install
+# This file is part of Drupal mode.
 
-VERSION=0.2.0
+# Copyright (C) 2012, 2013 Arne Jørgensen
 
-all: drupal-mode.info README
+# Author: Arne Jørgensen <[email protected]>
 
-drupal-mode.info: README.md
-	pandoc -t texinfo $^ | makeinfo -o $@
+# Drupal mode is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+
+# Drupal mode is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Drupal mode.  If not, see <http://www.gnu.org/licenses/>.
+
+.PHONY: all test clean install
+
+CASK?=cask
+EMACS?=emacs
+TAR?=bsdtar
+PANDOC?=pandoc --atx-headers
+
+VERSION?=$(shell $(CASK) version)
+
+ARCHIVE_NAME=drupal-mode
+PACKAGE_NAME=$(ARCHIVE_NAME)-$(VERSION)
+
+all: $(PACKAGE_NAME).tar
+
+test:
+	$(CASK) install
+	$(CASK) exec $(EMACS) --no-site-file --no-site-lisp --batch -L $(PWD) -l drupal-tests -f ert-run-tests-batch-and-exit
+
+$(ARCHIVE_NAME).info: README.md
+	$(PANDOC) -t texinfo $^ | makeinfo -o $@
 
 README: README.md
-	pandoc --atx-headers -t plain -o $@ $^
+	$(PANDOC) -t plain -o $@ $^
+
+$(ARCHIVE_NAME)-pkg.el: $(ARCHIVE_NAME).el
+	$(CASK) package
 
 # create a tar ball in package.el format for uploading to http://marmalade-repo.org
-elpa-package: README drupal-mode.el drupal-mode-pkg.el drupal-mode.info dir drupal/*.el
-	tar -c -s "@^@drupal-mode-${VERSION}/@" -f drupal-mode-${VERSION}.tar $^
-
-elpa-install: elpa-package
-	emacs --batch --eval "(progn \
-		(require 'package)\
-		(add-to-list 'package-archives '(\"marmalade\" . \"http://marmalade-repo.org/packages/\"))\
-		(package-initialize)\
-		(package-install-file \"`pwd`/drupal-mode-${VERSION}.tar\"))"
+$(PACKAGE_NAME).tar: README $(ARCHIVE_NAME).el $(ARCHIVE_NAME)-pkg.el $(ARCHIVE_NAME).info dir drupal/*.el drupal-tests.el drush-make-mode.el
+	COPYFILE_DISABLE=1 $(TAR) -c -s "@^@$(PACKAGE_NAME)/@" -f $(PACKAGE_NAME).tar $^
+
+install: $(PACKAGE_NAME).tar
+	$(EMACS) --batch -l package -f package-initialize --eval "(package-install-file \"$(PWD)/$(PACKAGE_NAME).tar\")"
+
+clean:
+	$(RM) $(ARCHIVE_NAME).info $(ARCHIVE_NAME)-*.tar $(ARCHIVE_NAME)-pkg.el README
+	$(RM) -r .cask

Makefile

@@ -14,13 +14,13 @@ Besides giving access to general functionality in all modes
 major mode to enable functionality only for that particular major mode
 (i.e. adhering to Drupals PHP coding standards only in php-mode).
 
-Drupal mode will try not to enforce specific ways of working with
+Drupal mode will not try to enforce specific ways of working with
 Emacs on to you. Emacs can be extended in a million different ways and
 you should use the parts and extensions that fit *you* and *your*
 working habits.
 
-If Drupal mode recognizes you using an extension that it knows about
-it will adapt the extension to be useful in Drupal mode and with
+If Drupal mode recognizes you are using an extension that it knows
+about it will adapt the extension to be useful in Drupal mode and with
 Drupal. I.e. it will recognize if you have loaded etags support and
 setup your buffers to use the TAGS file in your DRUPAL_ROOT folder.
 
@@ -57,8 +57,8 @@ it is considered a bug!
 
 #### Fixing line endings
 
-If your files are not written with unix style line endings Drupal mode
-will ask your to convert them to unix style line endings on saving
+If your files are not written with Unix style line endings Drupal mode
+will ask your to convert them to Unix style line endings on saving
 buffers.
 
 This behavior can be customized be the variable
@@ -83,35 +83,35 @@ This behavior can be customized be the variable
 ### Search documentation
 
 You can search Drupal documentation for the symbol at point by issuing
-`C-c d f` or `M-x drupal-search-documentation` or from the Drupal
+`C-c C-v C-d` or `M-x drupal-search-documentation` or from the Drupal
 menu entry.
 
 Files that are part of a Drupal project will try to identify the used
 version of Drupal core and look up the documentation for the
 corresponding version at http://api.drupal.org.
 
-If the symbol at point is believed to be a drush command the
+If the symbol at point is believed to be a Drush command the
 documentation will be looked up at http://api.drush.org instead. If
 Drush is installed it will identify the version of Drush and look up
-the documentation for that version.
+the documentation for the installed version of Drush.
 
-You can change where to search for documentation be customizing
+You can change where to search for documentation by customizing
 `drupal-search-url` (besides api.drupal.org it also has a predefined
 setting for api.drupalcontrib.org) and `drupal-drush-search-url`.
 
 
 ### Clearing all caches
 
 If Drush is installed you can issue a `drush cc all` from within Emacs
-by issuing `C-c d c` or `M-x drupal-drush-cache-clear` or from the
+by issuing `C-c C-v C-c` or `M-x drupal-drush-cache-clear` or from the
 Drupal menu entry.
 
 
 ### Drush editing minor mode
 
-If the buffer you visit is believe to be a Drush command (we think it
-is its name or path contains "drush") we will also enter a Drush minor
-mode.
+If the buffer you visit is believed to be a Drush command (we think it
+is if its file name or path contains "drush") we will also enter a
+Drush minor mode.
 
 There is currently no functionality connected to `drupal-drush-mode`.
 
@@ -123,7 +123,7 @@ If you have generated a TAGS file in your DRUPAL_ROOT folder Drupal
 mode will setup all buffers running drupal-mode to set
 `tags-file-name` to point to that TAGS file.
 
-Etags is a builtin part of Emacs.
+Etags is a built-in part of Emacs.
 
 
 ### GNU Globals / gtags
@@ -133,13 +133,21 @@ support in Emacs then Drupal mode will set `gtags-rootdir` to your
 DRUPAL_ROOT.
 
 
+### Drush utilities for Emacs users
+
+If
+[Drush utilities for Emacs users](http://drupal.org/project/emacs_drush)
+is installed Drupal mode will update existing tag files in your
+DRUPAL_ROOT after saving a buffer.
+
+
 ### ispell
 
 If ispell.el is loaded in Emacs then Drupal mode will set the language
 of your Drupal mode buffers to `american` as stated in [Drupals coding
 standards](http://drupal.org/coding-standards).
 
-ispell.el is a builtin part of Emacs. A external program must be
+ispell.el is a built-in part of Emacs. An external program must be
 installed to run the actual spell checking,
 i.e. [ispell](http://www.gnu.org/software/ispell/),
 [aspell](http://aspell.net/), or
@@ -150,27 +158,23 @@ i.e. [ispell](http://www.gnu.org/software/ispell/),
 
 If support for
 [flymake-phpcs.el](https://github.com/illusori/emacs-flymake-phpcs) is
-loaded in emacs and you have installed
+loaded in Emacs and you have installed
 [Drupal Code Sniffer](http://drupal.org/project/drupalcs) rules then
 Drupal mode will enable flymake-phpcs under php-mode.
 
 For this to work you need:
 
 *    [PHP CodeSniffer](http://pear.php.net/package/PHP_CodeSniffer)
-*    [flymake-phpcs.el](https://github.com/illusori/emacs-flymake-phpcs)
+*    [flymake-phpcs.el](http://marmalade-repo.org/packages/flymake-phpcs)
 *    [Drupal Code Sniffer](http://drupal.org/project/drupalcs) rules
 
-Making all of them work together can be a bit of a puzzle. Especially
-notice the need to run `phpcs` through a wrapper you get with
-flymake-phpcs.el.
-
 
 ## Other takes on a Drupal mode
 
 There are quite a few attempts at writing a Drupal mode out in the
 wild:
 
-*    [Search Github for drupal-mode](https://github.com/search?type=Repositories&q=drupal-mode)
+*    [Search Github for drupal-mode](https://github.com/search?type=Repositories&q="drupal-mode")
 *     At drupal.org:
 	* http://drupal.org/sandbox/bartlantz/1405156
 	* http://drupal.org/project/emacs
@@ -183,4 +187,4 @@ All of them more or less based on
 
 Drupal mode is actively developed at
 [GitHub](https://github.com/arnested/drupal-mode).  Feature requests,
-ideas, bug reports, and pull request are more that welcome!
+ideas, bug reports, and pull request are more than welcome!