summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-12-29 15:27:20 -0500
committerJoey Hess <joey@gnu.kitenet.net>2009-12-29 15:27:20 -0500
commitb18201805c64970a9a439637beee52b981160d8e (patch)
treeda21b4c2646c7ecbbfa7a2ec87453141bb13431e /doc
parent29ce222e43b69ee8bec4c471c2cafdb7a293068c (diff)
downloaddebhelper-b18201805c64970a9a439637beee52b981160d8e.tar.gz
stop trying to handle substvars idempotently
In the beginning, I tried to be careful to have commands that added a substvar remove it when ran again with different options that caused it to not be needed. However, now when I look over the code, I see 3 places that got it right, 1 that was right but I just broke, and a dozen that don't even try to handle this case. Also, handling the case is hard; code that adds substvars may be complex and calculate versioned dependencies. The removal code then has to somehow also come up with those same exact dependency strings. It's a recipe for nasty code and maintenance headache even if I went and fixed everything right now. Instead, I dropped the whole thing. Many debhelper commands make no pretense of being idempotent anyway; it's easy and normal to call dh_prep when starting a binary package build, with the exact purpose of not needing to worry about idempotency. I did leave in the delsubstvar function, as well as the option to addsubstvar that, confusingly, causes an item to be removed. Just for library compatability reasons.
Diffstat (limited to 'doc')
-rw-r--r--doc/PROGRAMMING7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING
index 0fca4722..ca76b9c9 100644
--- a/doc/PROGRAMMING
+++ b/doc/PROGRAMMING
@@ -216,9 +216,10 @@ addsubstvar($package, $substvar, $deppackage, $verinfo, $remove)
- version info for the package (optional) (ie: ">= 1.1")
- if this last parameter is passed, the thing that would be added
is removed instead. This can be useful to ensure that a debhelper
- command is idempotent. Note that without this parameter, if you
- call the function twice with the same values it will only add one
- item to the substvars file.
+ command is idempotent. (However, we generally don't bother,
+ and rely on the user calling dh_prep.) Note that without this
+ parameter, if you call the function twice with the same values it
+ will only add one item to the substvars file.
delsubstvar($package, $substvar)
This function removes the entire line for the substvar from the
package's shlibs file.