]> git.donarmstrong.com Git - debhelper.git/blobdiff - debhelper.pod
Fix build system auto-selection breakage.
[debhelper.git] / debhelper.pod
index 8ea3f31fa11d7dfc033461ff5588825c02ebfeda..98aa422cffd48922d1aa31e7586a43ef5a96927f 100644 (file)
@@ -28,7 +28,7 @@ package contains a tutorial about making your first package using debhelper.
 
 =head1 DEBHELPER COMMANDS
 
-Here is the complete list of available debhelper commands. See their man
+Here is the list of debhelper commands you can use. See their man
 pages for additional documentation.
 
 =over 4
@@ -37,8 +37,20 @@ pages for additional documentation.
 
 =back
 
+=head2 Deprecated Commands
+
+A few debhelper commands are deprecated and should not be used.
+
+=over 4
+
+#LIST_DEPRECATED#
+
+=back
+
+=head2 Other Commands
+
 If a program's name starts with "dh_", and the program is not on the above
-list, then it is not part of the debhelper package, but it should still
+lists, then it is not part of the debhelper package, but it should still
 work like the other programs described on this page.
 
 =head1 DEBHELPER CONFIG FILES
@@ -205,23 +217,16 @@ If the build system prefers out of source tree building but still
 allows in source building, the latter can be re-enabled by passing a build
 directory path that is the same as the source directory path.
 
-=item B<-j>[I<maximum>], B<--parallel>[I<=maximum>]
-
-Indicate that a source package supports building using multiple parallel
-processes. However, the package will be built in this mode only if the build
-system supports this feature and tag I<parallel=n> is present in the
-DEB_BUILD_OPTIONS environment variable (as per Debian Policy section 4.9.1).
-The number of spawned parallel processes will be the smallest value of I<n>,
-I<maximum> (if specified) or a build system specific limit.
+=item B<--max-parallel>I<=maximum>
 
-If value of I<maximum> is 1, parallel building will be forcefully disabled.
-Such construct can be used to negate effects of the previously specified
-I<--parallel> option.
+By default, the DEB_BUILD_OPTIONS environment variable can be used to
+enable parallel building, when supported by the build system.
 
-If I<--parallel> is not specified, a debhelper build system will neither
-attempt to enforce nor prevent parallel building. This typically means a source
-package does not to support parallel building or enforces it in other ways
-(e.g. by modifying MAKEFLAGS manually).
+This option allows controlling how many parallel jobs can be used in a
+build. If set to 1, concurrent builds are disabled -- do this if
+the package build is known not to work in parallel. If the package build
+is known to only work with certian levels of concurrency, you can set this
+to the maximum level that is known to work, or that you wish to support.
 
 =item B<--list>, B<-l>