branch: master
commit e1d51286a94432272d2285f9118289042c4eb1d2
Author: fabacino <[email protected]>
Commit: fabacino <[email protected]>
Makefile: Add target checkdoc to check documentation guidelines of lisp
files
---
Makefile | 5 ++++-
README.md | 2 +-
targets/checkdoc.el | 6 ++++++
3 files changed, 11 insertions(+), 2 deletions(-)
diff --git a/Makefile b/Makefile
index f5fef20..b4df4ff 100644
--- a/Makefile
+++ b/Makefile
@@ -8,6 +8,9 @@ all: test
test:
$(emacs) -batch $(LOAD) -l ivy-test.el -f ert-run-tests-batch-and-exit
+checkdoc:
+ $(emacs) -batch -l targets/checkdoc.el
+
compile:
$(emacs) -batch --eval "(progn (add-to-list 'load-path
default-directory) (mapc #'byte-compile-file '(\"ivy.el\" \"swiper.el\"
\"counsel.el\" \"colir.el\" \"ivy-overlay.el\")))"
@@ -24,4 +27,4 @@ update-issues:
clean:
rm -f *.elc
-.PHONY: all compile clean test update-issues
+.PHONY: all compile clean test update-issues checkdoc
diff --git a/README.md b/README.md
index 7cdb9ac..9b0017f 100644
--- a/README.md
+++ b/README.md
@@ -112,6 +112,6 @@ The copyright assignment isn't a big deal, it just says
that the copyright for y
The basic code style guide is to use `(setq indent-tabs-mode nil)`. It is
provided for you in
[.dir-locals.el](https://github.com/abo-abo/swiper/blob/master/.dir-locals.el),
please obey it.
-Before submitting the change, run `make compile` and `make test` to make sure
that it doesn't introduce new compile warnings or test failures. Also run
<kbd>M-x</kbd> `checkdoc` to see that your changes obey the documentation
guidelines.
+Before submitting the change, run `make compile` and `make test` to make sure
that it doesn't introduce new compile warnings or test failures. Also run `make
checkdoc` to see that your changes obey the documentation guidelines.
Use your own judgment for the commit messages, I recommend a verbose style
using `magit-commit-add-log`.
diff --git a/targets/checkdoc.el b/targets/checkdoc.el
new file mode 100644
index 0000000..3162d36
--- /dev/null
+++ b/targets/checkdoc.el
@@ -0,0 +1,6 @@
+(checkdoc-file "colir.el")
+(checkdoc-file "counsel.el")
+(checkdoc-file "ivy-overlay.el")
+(checkdoc-file "ivy-test.el")
+(checkdoc-file "ivy.el")
+(checkdoc-file "swiper.el")
