From 6da2097de0b3b6999d8d7a1c1348ee78697eaa08 Mon Sep 17 00:00:00 2001 From: John Maddock Date: Thu, 18 Apr 2013 12:31:16 +0000 Subject: [PATCH] Fix formatting. Refs #8377. [SVN r83953] --- doc/bcp.qbk | 1 + doc/html/index.html | 61 ++++++++++++++++++++++++++------------------- 2 files changed, 36 insertions(+), 26 deletions(-) diff --git a/doc/bcp.qbk b/doc/bcp.qbk index 905a201..2d6b1cf 100644 --- a/doc/bcp.qbk +++ b/doc/bcp.qbk @@ -175,6 +175,7 @@ their dependencies and so on. * HTML files are scanned for immediate dependencies (images and style sheets, but not links). It should be noted that in practice bcp can produce a rather "fat" list of dependencies, reasons for this include: + * It searches for library names first, so using "regex" as a name will give you everything in the libs/regex directory and everything that depends on. This can be a long list as all the regex test and example programs will get scanned for their dependencies. If you want a more minimal list, then try using the diff --git a/doc/html/index.html b/doc/html/index.html index 1646326..bf59356 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -3,7 +3,7 @@ BCP - + @@ -50,7 +50,7 @@ -
+
@@ -64,7 +64,7 @@ what licences are used by those dependencies.

-
+
@@ -111,7 +111,7 @@ The report contains license information, author details, and file dependencies.

-
+
@@ -122,7 +122,7 @@
output-path
Dependencies
-
+
@@ -141,7 +141,7 @@

Outputs a html report file containing:

-
    +
    • All the licenses in effect, plus the files using each license, and the copyright holders using each license. @@ -163,7 +163,7 @@
-
+
@@ -211,7 +211,7 @@ Make sure that all copied files use Unix style line endings.

-
+
@@ -243,7 +243,7 @@ copied/listed.

-
+
@@ -251,14 +251,14 @@ The path to which files will be copied (this path must exist).

-
+

File dependencies are found as follows:

-
    +
    • C++ source files are scanned for #includes, all #includes present in the boost source tree will then be scanned for their dependencies and @@ -280,27 +280,36 @@

    It should be noted that in practice bcp can produce a rather "fat" - list of dependencies, reasons for this include: * It searches for library - names first, so using "regex" as a name will give you everything - in the libs/regex directory and everything that depends on. This can be a - long list as all the regex test and example programs will get scanned for - their dependencies. If you want a more minimal list, then try using the names - of the headers you are actually including, or use the --scan option to scan - your source code. * If you include the header of a library with separate - source, then you get that libraries source and all it's dependencies. This - is deliberate and in general those extra dependencies are needed. * When - you include a header, bcp doesn't know what compiler you're using, so it - follows all possible preprocessor paths. If you're distributing a subset - of Boost with you're application then that is what you want to have happen - in general. + list of dependencies, reasons for this include:

    +
      +
    • + It searches for library names first, so using "regex" as a + name will give you everything in the libs/regex directory and everything + that depends on. This can be a long list as all the regex test and example + programs will get scanned for their dependencies. If you want a more + minimal list, then try using the names of the headers you are actually + including, or use the --scan option to scan your source code. +
      • +
    • + If you include the header of a library with separate source, then you + get that libraries source and all it's dependencies. This is deliberate + and in general those extra dependencies are needed. +
      • +
    • + When you include a header, bcp doesn't know what compiler you're using, + so it follows all possible preprocessor paths. If you're distributing + a subset of Boost with you're application then that is what you want + to have happen in general. +
      • +

    The last point above can result in a substantial increase in the number of headers found compared to most peoples expectations. For example bcp finds 274 header dependencies for boost/shared_ptr.hpp: by running bcp in report mode we can see why all these headers have been found as dependencies:

    -
      +
      • All of the Config library headers get included (52 headers, would be about 6 for one compiler only). @@ -338,7 +347,7 @@
    - +

    Last revised: November 22, 2012 at 08:56:37 GMT

    Last revised: April 18, 2013 at 12:30:13 GMT