summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-10-21 14:50:27 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-10-21 14:50:27 -0400
commitd6759d6a6c9c354abad02ddfbee6782357c8ed6b (patch)
tree81e135e6fa422e83df281f9e5a2a282378628a3f /doc
parent3c458775d1180d034217c4b44e3871d8b87bf382 (diff)
Move many command-specific options to only be accepted by the command that uses them.
Affected options are: -x, -r, -R, -l, -L, -m, --include-conffiles, --no-restart-on-upgrade, --no-start, --restart-after-upgrade, --init-script, --filename, --flavor, --autodest, --libpackage, --add-udeb, --dpkg-shlibdeps-params, --dpkg-gencontrol-params, --update-rcd-params, --major, --remove-d, --dirs-only, --keep-debug, --version-info, --list-missing, --fail-missing, --language, --until, --after, --before, --remaining, --with * If any third-party debhelper commands use any of the above options, they will be broken, and need to be changed to pass options to init(). * To avoid breaking rules files that pass options to commands that do not use them, debhelper will now only warn if it encounters an unknown option. This will be converted back to an error later.
Diffstat (limited to 'doc')
-rw-r--r--doc/PROGRAMMING29
-rw-r--r--doc/TODO8
2 files changed, 9 insertions, 28 deletions
diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING
index 0d96457..3cea384 100644
--- a/doc/PROGRAMMING
+++ b/doc/PROGRAMMING
@@ -106,27 +106,19 @@ switch variable description
-X EXCLUDE exclude a something from processing (you
decide what this means for your program)
(This is an array)
- EXCLUDE_FIND same as DH_EXCLUDE, except all items are put
+-X EXCLUDE_FIND same as EXCLUDE, except all items are put
into a string in a way that they will make
find find them. (Use ! in front to negate
that, of course) Note that this should
only be used inside complex_doit(), not in
doit().
--x INCLUDE_CONFFILES
- include conffiles. It's -x for obscure
- historical reasons.
-d D_FLAG you decide what this means to your program
--r R_FLAG you decide what this means to your program
--k K_FLAG you decide what this means to your program
+-k K_FLAG used to turn on keeping of something
-P TMPDIR package build directory (implies only one
package is being acted on)
-u U_PARAMS will be set to a string, that is typically
parameters your program passes on to some
other program. (This is an array)
--m M_PARAMS will be set to a string, you decide what it
- means to your program
--l L_PARAMS will be set to a string, you decide what it
- means to your program
-V V_FLAG will be set to a string, you decide what it
means to your program
-V V_FLAG_SET will be 1 if -V was specified, even if no
@@ -136,23 +128,14 @@ switch variable description
those processed here), will apply to all
binary packages the program acts on, not just
the first
---init-script INIT_SCRIPT will be set to a string, which specifies an
- init script name (probably only
- dh_installinit will ever use this)
---sourcedir SOURCEDIR will be set to a string (probably only
- dh_movefiles will ever use this)
---destdir DESTDIR will be set to a string (probably only
- dh_builddeb will ever use this)
---filename FILENAME will be set to a string
---flavor FLAVOR will be set to a string (probably only
- dh_installemacsen will ever use this)
---number PRIORITY will be set to a number (deprecated)
+--sourcedir SOURCEDIR will be set to a string
+--destdir DESTDIR will be set to a string
--priority PRIORITY will be set to a number
+--mainpackage MAINPACKAGE controls which package is treated as the
+ main package to act on
--name NAME a name to use for installed files, instead of
the package name
--error-handler ERROR_HANDLER a function to call on error
---language LANGUAGE specify what language a file is in
---add-udeb SHLIBS_UDEB used by dh_makeshlibs
Any additional command line parameters that do not start with "-" will be
ignored, and you can access them later just as you normally would.
diff --git a/doc/TODO b/doc/TODO
index 0a7354f..d598db6 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -3,11 +3,6 @@ list grows - I welcome patches to fix items on it!
Wishlist items:
-* All debhelper programs should only accept the options they are documented
- to accept (rather than accepting all debhelper options). This is mostly a
- matter of moving command-specific options out of Dh_Getopt and into the
- individial command's calls to init(). (#112349)
-
v8:
* escaping in config files (for whitespace)?
@@ -34,3 +29,6 @@ Deprecated:
* dh_installinit --init-script
* dh_python
* dh_clean -k (make it warn)
+* Convert warning about unknown command-line options back to an error.
+ Need to wait a file (from Oct 2008) to ensure that most rules files
+ that pass unknown options to commands are fixed.