summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/hook-pre-commit-pkg/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/hook-pre-commit-pkg/README')
-rw-r--r--Master/texmf-dist/doc/support/hook-pre-commit-pkg/README39
1 files changed, 39 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/hook-pre-commit-pkg/README b/Master/texmf-dist/doc/support/hook-pre-commit-pkg/README
new file mode 100644
index 00000000000..ab146317b61
--- /dev/null
+++ b/Master/texmf-dist/doc/support/hook-pre-commit-pkg/README
@@ -0,0 +1,39 @@
+Pre-commit hook for LaTeX package developpers
+
+
+=== What it is ?
+A pre-commit hook to check basic LaTeX syntaxe for develloper 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.0
+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.
+
+