summaryrefslogtreecommitdiff
path: root/support/hook-pre-commit-pkg/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/hook-pre-commit-pkg/README
Initial commit
Diffstat (limited to 'support/hook-pre-commit-pkg/README')
-rw-r--r--support/hook-pre-commit-pkg/README39
1 files changed, 39 insertions, 0 deletions
diff --git a/support/hook-pre-commit-pkg/README b/support/hook-pre-commit-pkg/README
new file mode 100644
index 0000000000..8d8cf08e65
--- /dev/null
+++ b/support/hook-pre-commit-pkg/README
@@ -0,0 +1,39 @@
+Pre-commit hook for LaTeX package developers
+
+
+=== What it is ?
+A pre-commit hook to check basic LaTeX syntax for developer of package.
+
+==== How to install
+Copy pre-commit in the .git/hooks file
+Add execution right (chmod +x)
+Enjoy !
+
+====Checked files
+ - .sty
+ - .dtx
+ - .bbx
+ - .cbx
+ - .lbx
+
+====What are checked
+Only for new line, these properties are checked:
+ - All line must finish by a %, without space before.
+ Empty line are allowed, but not line with blank space.
+ - \begin{macro} and \end{macro} must be paired.
+ - \begin{macrocode} and \end{macrocode} must be paired.
+ - \begin{macro} must have a second argument.
+ - 1 space must be printed between % and \begin{macro} of \end{macro}. % Must be the first line character.
+ - 4 spaces must be printed between % and \begin{macrocode} or \end{macrocode}.
+ - \cs argument must NOT start by an \
+
+=== Licence and copyright
+Maïeul Rouquette 2014-....
+v 1.1.2
+Licence GPl3 https://www.gnu.org/licenses/gpl-3.0.txt
+
+=== Help and github repository
+https://github.com/maieul/git-hooks
+Open an issue for any needs.
+
+