monotone-doc 1.0-12 / usr / share / doc / monotone / html / Validation-Hooks.html

This file is indexed.

/usr/share/doc/monotone/html/Validation-Hooks.html is in monotone-doc 1.0-12.

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
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>monotone documentation: Validation Hooks</title>

<meta name="description" content="monotone documentation: Validation Hooks">
<meta name="keywords" content="monotone documentation: Validation Hooks">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="General-Index.html#General-Index" rel="index" title="General Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Hooks.html#Hooks" rel="up" title="Hooks">
<link href="Additional-Lua-Functions.html#Additional-Lua-Functions" rel="next" title="Additional Lua Functions">
<link href="GIT-Export-Hooks.html#GIT-Export-Hooks" rel="prev" title="GIT Export Hooks">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="texinfo.css">


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Validation-Hooks"></a>
<div class="header">
<p>
Previous: <a href="GIT-Export-Hooks.html#GIT-Export-Hooks" accesskey="p" rel="prev">GIT Export Hooks</a>, Up: <a href="Hooks.html#Hooks" accesskey="u" rel="up">Hooks</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="General-Index.html#General-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Validation-Hooks-1"></a>
<h4 class="subsection">6.1.12 Validation Hooks</h4>

<p>If there is a policy decision to make, Monotone defines certain hooks to
allow a client to validate or reject certain behaviors.
</p>
<dl compact="compact">
<dt><code>validate_changes (<var>revision_text</var>, <var>branchname</var>)</code>
<a name="index-validate_005fchanges-_0028revision_005ftext_002c-branchname_0029"></a>
</dt>
<dd>
<p>This hook is called by <code><a href="Workspace.html#mtn-commit">mtn commit</a></code> just after the
to-be-committed changes and the branch have been logically verified
and before the user enters his/her commit message.
<var>revision_text</var> is the full text of the changes for this revision,
which can be parsed with the <code><a href="Additional-Lua-Functions.html#parse_005fbasic_005fio">parse_basic_io</a></code> function. The
second parameter, <var>branchname</var>, is the branch for this commit -
unless it gets changed in <code><a href="User-Defaults.html#edit_005fcomment">edit_comment</a></code> later on.
</p>
<p>If the hook finds the changes satisfactory, it should return
<code>true, &quot;&quot;</code>. If it finds fault, then it should return <code>false,
reason</code> where <var>reason</var> is a string containing the reason the
changes were rejected. By default, this hook is not defined and acts
as if it returned <code>true, &quot;&quot;</code>.
</p>
</dd>
<dt><code>validate_commit_message (<var>message</var>, <var>revision_text</var>, <var>branchname</var>)</code>
<a name="index-validate_005fcommit_005fmessage-_0028message_002c-revision_005ftext_002c-branchname_0029"></a>
</dt>
<dd>
<p>This hook is called by <code><a href="Workspace.html#mtn-commit">mtn commit</a></code> after
<code><a href="User-Defaults.html#edit_005fcomment">edit_comment</a></code>.  <var>message</var> is the result of
<code>edit_comment</code> and <var>revision_text</var> is the full text of the
changes for this revision, which can be parsed with the
<code><a href="Additional-Lua-Functions.html#parse_005fbasic_005fio">parse_basic_io</a></code> function.  <var>branchname</var> is parsed from
the result of <code>edit_comment</code>.
</p>
<p>If the hook finds the commit message satisfactory, it should return
<code>true, &quot;&quot;</code>. If it finds fault, then it should return <code>false,
reason</code> where <var>reason</var> is a string containing the reason the
message was rejected. By default, this hook is not defined and acts as
if it returned <code>true, &quot;&quot;</code>.
</p>
</dd>
</dl>




</body>
</html>

APT Browse - Built by Thomas Orozco.