From eca6ddc4d0a5248ec1406bdad8bc46fe3e5f50e3 Mon Sep 17 00:00:00 2001
From: Diego Elio Pettenò <flameeyes@gentoo.org>
Date: Mon, 1 Jan 2007 23:51:29 +0000
Subject: Document patch_trigger_action function.

svn path=/trunk/; revision=37
---
 doc/writing.docbook | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/doc/writing.docbook b/doc/writing.docbook
index 44e32db..afe0b8b 100644
--- a/doc/writing.docbook
+++ b/doc/writing.docbook
@@ -74,6 +74,28 @@ and used by autoepatch safely.
     </para>
     </listitem>
   </varlistentry>
+
+  <varlistentry>
+    <term>patch_trigger_action</term>
+    <listitem>
+
+    <para>
+    This function is the core of those patchsets without actual patch
+    files to apply. It is called once per target to execute some
+    commands on the given parameter. It is useful to run a sed
+    command, or to parse the file in some complex way, and produce
+    either a new output or changing the target file.
+    </para>
+
+    <para>
+    Another likely usage of this ind of patchsets is to operate on a
+    given directory, where you have to change the files according to
+    some other file, for example if you're gonna change some gettext
+    support.
+    </para>
+
+    </listitem>
+  </varlistentry>
 </variablelist>
 
 </sect1>
-- 
cgit v1.2.3-65-gdbad