diff options
| author | Modestas Vainius <modestas@vainius.eu> | 2009-06-18 02:11:45 +0300 |
|---|---|---|
| committer | Modestas Vainius <modestas@vainius.eu> | 2009-06-18 02:11:45 +0300 |
| commit | 962a2e10c930e3504ea1c0327be2fdf70d53023e (patch) | |
| tree | 26196a25203b03818d92dd5a8ec49d2e13111675 /dh_auto_build | |
| parent | 91928482af09c4ca1092f124921d0f47613c17ba (diff) | |
Update dh_auto documentation.
* dh_auto.pod -> dh_auto.7 - contains general information about dh_auto,
its features, build systems supported by default (the latter is injected by
man/dh_auto_pod script from Debian/Debhelper/Buildsystem/*.pm PODs via
placeholders (#PLACEHOLDER#))
* POD in Debian/Debhelper/Buildsystem/*.pm -> dh_auto_<buildsystem>.7 - build
system specific information.
* dh_auto_* -> dh_auto_*.1 - relatively shorty description of the specific
dh_auto_* program and build system specific info for that step injected from
Debian/Debhelper/Buildsystem/*.pm with man/dh_auto_pod script.
* man/dh_auto_pod $step - generates full dh_auto_$step POD (replaces
placeholders).
* man/dh_auto_pod - generates full dh_auto.pod (replaces placeholders).
Signed-off-by: Modestas Vainius <modestas@vainius.eu>
Diffstat (limited to 'dh_auto_build')
| -rwxr-xr-x | dh_auto_build | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/dh_auto_build b/dh_auto_build index 56b9b5f0..d16694cf 100755 --- a/dh_auto_build +++ b/dh_auto_build @@ -2,7 +2,7 @@ =head1 NAME -dh_auto_build - automatically builds a package +dh_auto_build - build package sources =cut @@ -11,18 +11,21 @@ use Debian::Debhelper::Dh_Buildsystems; =head1 SYNOPSIS -B<dh_auto_build> [S<I<debhelper options>>] [S<B<--> I<params>>] +B<dh_auto_build> [S<I<debhelper options>>] [S<I<dh_auto options>>] [S<B<--> I<params>>] =head1 DESCRIPTION -dh_auto_build is a debhelper program that tries to automatically -build a package. If a Makefile is found, this is done by running make (or -MAKE, if the environment variable is set). -If there's a setup.py, or Build.PL, it is run to build the package. +dh_auto_build is a debhelper program that is responsible for the I<build> step +of the L<dh_auto(7)> building process. Typically, this is the point when +package sources are compiled into binaries or otherwise transformed into ready +to use format. Files produced throughout this step are put to the build +directory. -This is intended to work for about 90% of packages. If it doesn't work, -you're encouraged to skip using dh_auto_build at all, and just run the -build process manually. +You can pass additional parameters via I<params>. However, if dh_auto_build +does not meet your needs or does not work, it is safe to skip/override it +entirely and build the package with custom commands. + +#DH_AUTO SHARED OPTIONS# =head1 OPTIONS @@ -35,6 +38,11 @@ or override any standard parameters that dh_auto_build passes. =back +=head1 SUPPORTED BUILD SYSTEMS + +#SUPPORTED BUILD SYSTEMS INTRO# +#SUPPORTED BUILD SYSTEMS LIST# + =cut buildsystems_init(); @@ -42,12 +50,16 @@ buildsystems_do(); =head1 SEE ALSO +L<dh_auto(7)> + L<debhelper(7)> -This program is a part of debhelper. +This program is a part of debhelper and its dh_auto package source building +suite. =head1 AUTHOR -Joey Hess <joeyh@debian.org> + Joey Hess <joeyh@debian.org> + Modestas Vainius <modestas@vainius.eu> =cut |