summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDiego Elio Pettenò <flameeyes@gentoo.org>2006-12-30 09:05:22 +0000
committerDiego Elio Pettenò <flameeyes@gentoo.org>2006-12-30 09:05:22 +0000
commit0a693ae6b6fde595384a4583af189451a24617fe (patch)
tree1ef9385978a9f179cfe764a388946d7d41f05b42 /doc/writing.docbook
parentRemove IFS reset, as the set was removed already. (diff)
downloadautoepatch-0a693ae6b6fde595384a4583af189451a24617fe.tar.gz
autoepatch-0a693ae6b6fde595384a4583af189451a24617fe.tar.bz2
autoepatch-0a693ae6b6fde595384a4583af189451a24617fe.zip
Start writing documentation on writing patchsets.
svn path=/trunk/; revision=31
Diffstat (limited to 'doc/writing.docbook')
-rw-r--r--doc/writing.docbook17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/writing.docbook b/doc/writing.docbook
index 96790fb..f33b293 100644
--- a/doc/writing.docbook
+++ b/doc/writing.docbook
@@ -2,6 +2,23 @@
<title>Writing Patchsets</title>
<para>
+This chapter will try to cover all the needed knowledge to write a new
+patchset for autoepatch, as well as to maintain the ones already
+present in the distribution.
</para>
+<sect1 id="writingthescript">
+<title>The patchset's script</title>
+
+<para>
+An autoepatch patchset consists at least of two atoms: a directory,
+whose name is also the name of the patchset, and a bash script, inside
+that directory, named the same way with ".sh" extension. That script
+is the core of the patchset, as it will tell autoepatch where to find
+the files to patch, what kind of patchset it is, and whether to fail
+or not if the patching is not completed as intended.
+</para>
+
+</sect1>
+
</chapter>