[Pkg-bazaar-commits] r190 ./bzr-builddeb/people/jdw/dev: Add the start of a spec for hooks.

[James Westby]

------------------------------------------------------------
revno: 190
committer: James Westby <jw+debian at jameswestby.net>
branch nick: dev
timestamp: Sun 2007-09-16 18:38:22 +0100
message:
  Add the start of a spec for hooks.
added:
  specs/hooks
-------------- next part --------------
=== added file 'specs/hooks'
--- a/specs/hooks	1970-01-01 00:00:00 +0000
+++ b/specs/hooks	2007-09-16 17:38:22 +0000
@@ -0,0 +1,29 @@
+Hooks
+=====
+
+Status: Draft
+
+Rationale
+---------
+
+Sometimes there may need to be operations done on the source tree to prepare
+for building that are not appropriate for debian/rules. For instance running
+autotools on the source in order to have the configure script available for
+use in the source package.
+
+To accomodate all requirements hooks can be supported to run a command at
+a predefined point.
+
+Design
+------
+
+The user speficies the hooks using a ``[HOOKS]`` section in the configuration
+files. The key is the name of the hook point, and the value is the command
+to run at that hook point.
+
+In order to protect new users from the surprise of code being run from an
+unexpected location hook support could be required to be enabled for hooks
+to be executed for that user. This would however cause unexpected build
+failures that could be hard to debug, and so in balance the safety may not
+be worth it.
+