/usr/share/doc/libghc-gitrev-doc/html/Development-GitRev.html is in libghc-gitrev-doc 1.2.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Development.GitRev</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Development-GitRev.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Development-GitRev.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gitrev-1.2.0: Compile git revision info into Haskell projects</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) 2015 Adam C. Foltzer</td></tr><tr><th>License</th><td>BSD3</td></tr><tr><th>Maintainer</th><td>acfoltzer@galois.com</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Development.GitRev</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Some handy Template Haskell splices for including the current git
hash and branch in the code of your project. Useful for including
in panic messages, <code>--version</code> output, or diagnostic info for more
informative bug reports.</p><pre>{-# LANGUAGE TemplateHaskell #-}
import Development.GitRev
panic :: String -> a
panic msg = error panicMsg
where panicMsg =
concat [ "[panic ", $(gitBranch), "@", $(gitHash)
, " (", $(gitCommitDate), ")"
, " (", $(gitCommitCount), " commits in HEAD)"
, dirty, "] ", msg ]
dirty | $(gitDirty) = " (uncommitted files present)"
| otherwise = ""
main = panic "oh no!"</pre><pre>% cabal exec runhaskell Example.hs
Example.hs: [panic master@2ae047ba5e4a6f0f3e705a43615363ac006099c1 (Mon Jan 11 11:50:59 2016 -0800) (14 commits in HEAD) (uncommitted files present)] oh no!</pre></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:gitHash">gitHash</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a></li><li class="src short"><a href="#v:gitBranch">gitBranch</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a></li><li class="src short"><a href="#v:gitDirty">gitDirty</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a></li><li class="src short"><a href="#v:gitCommitCount">gitCommitCount</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a></li><li class="src short"><a href="#v:gitCommitDate">gitCommitDate</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:gitHash" class="def">gitHash</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a> <a href="src/Development-GitRev.html#gitHash" class="link">Source</a> <a href="#v:gitHash" class="selflink">#</a></p><div class="doc"><p>Return the hash of the current git commit, or <code>UNKNOWN</code> if not in
a git repository</p></div></div><div class="top"><p class="src"><a id="v:gitBranch" class="def">gitBranch</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a> <a href="src/Development-GitRev.html#gitBranch" class="link">Source</a> <a href="#v:gitBranch" class="selflink">#</a></p><div class="doc"><p>Return the branch (or tag) name of the current git commit, or <code>UNKNOWN</code>
if not in a git repository. For detached heads, this will just be
<a href="HEAD.html">HEAD</a></p></div></div><div class="top"><p class="src"><a id="v:gitDirty" class="def">gitDirty</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a> <a href="src/Development-GitRev.html#gitDirty" class="link">Source</a> <a href="#v:gitDirty" class="selflink">#</a></p><div class="doc"><p>Return <code>True</code> if there are non-committed files present in the
repository</p></div></div><div class="top"><p class="src"><a id="v:gitCommitCount" class="def">gitCommitCount</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a> <a href="src/Development-GitRev.html#gitCommitCount" class="link">Source</a> <a href="#v:gitCommitCount" class="selflink">#</a></p><div class="doc"><p>Return the number of commits in the current head</p></div></div><div class="top"><p class="src"><a id="v:gitCommitDate" class="def">gitCommitDate</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/template-haskell-2.11.0.0/Language-Haskell-TH-Lib.html#t:ExpQ">ExpQ</a> <a href="src/Development-GitRev.html#gitCommitDate" class="link">Source</a> <a href="#v:gitCommitDate" class="selflink">#</a></p><div class="doc"><p>Return the commit date of the current head</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
|