simplify

[debhelper.git] / debhelper.pod

diff --git a/debhelper.pod b/debhelper.pod
index 238675ab6f084378057dbf7c5396e535365cf7e2..a4765baba8367f458a96f5fa1cc80a07056a061a 100644 (file)
--- a/debhelper.pod
+++ b/debhelper.pod
@@ -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,18 +217,22 @@ 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>]
+=item B<--parallel>
+
+Enable parallel builds if underlying build system supports them.
+The number of parallel jobs is controlled by the
+DEB_BUILD_OPTIONS environment variable (L<Debian Policy, section 4.9.1>) at
+build time. It might also be subject to a build system specific limit.
+
+If this option is not specified, debhelper currently defaults to not
+allowing parallel package builds.
 
-Indicate that a source package supports building using multiple parallel
-processes. This only enables parallel building if the build system supports
-it, and I<parallel=n> is present in the DEB_BUILD_OPTIONS environment
-variable (as per Debian Policy section 4.9.1).
+=item B<--max-parallel>I<=maximum>
 
-The number of parallel processes will be the smaller value specified by
-I<--parallel>, DEB_BUILD_OPTIONS, or a build system specific limit.
-So, I<--parallel=1> can be used to disable parallel building, or a larger
-number can be specified if a package is known to only successfully build
-with a limited number of parallel processes.
+This option implies L<--parallel> and allows further limiting the number of
+jobs that can be used in a parallel build. If the package build is known to
+only work with certain 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>