jcalov/jgitinfo

Use git repository metadata in LaTeX documents.

jgitinfo's Issues

Extend README: how to ensure watermark info if repo is dirty

The package only can know if the repo is dirty if one of the installed git hooks was invoked. So you have to ensure that you invoke one of them before compiling your latex document.

One possibility is to checkout a file that is in every branch of every repo and changes extremely rarely. Normally that file is .gitignore, so you can run git checkout .gitignore before every compile.

How you configure this in TexStudio ist described in section 1.3 of the TeXstudio user manual.

Silent option only for not installed git hooks

When using git-latexdiff and not using the silent option of the jgitinfo package, the pdf output of the diff has the prominent watermark that git hooks are not installed which is very annoying.

Integrate an additional flag silent-not-installed that makes no watermark if git hooks are not installed, but that shows the prominent notice if repo is dirty.

Provide git hook files from gitinfo2 package

Provide the git hook files from gitinfo2 package in repo. But check license before!

Extend README: Installation instructions

Provide information for installation, like:

Installation

• Copy the files from the repo folder git_hooks into your local repository folder .git/hooks/
• Make the files executable, e.g. with chmod 755 .git/hooks/post-*
• Ensure that you invoke on of the hooks before compiling your latex document (see previous section)

For more information see the package documentation for the gitinfo2 package.

typo: Dirty in silent mode

In watermark text, everything is written in lower case, but in silent mode, the dirty flag in watermark begins with an upper case D.