From e507afef19af3676b01db2543554ce58392bf97d Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Sun, 25 Nov 2007 17:12:42 +0000 Subject: [PATCH] Some cleanup of tools documentation. Add boostbook redir file. Delete duplicate time_string.hpp. Repoint regression instructions to web site. [SVN r41363] --- tools/boostbook | 2 +- tools/common/time_string.hpp | 53 ------------ tools/regression/doc/index.html | 9 +- tools/regression/doc/instructions.html | 109 ------------------------- 4 files changed, 7 insertions(+), 166 deletions(-) delete mode 100644 tools/common/time_string.hpp delete mode 100644 tools/regression/doc/instructions.html diff --git a/tools/boostbook b/tools/boostbook index 2b41478df0..7f650958d2 160000 --- a/tools/boostbook +++ b/tools/boostbook @@ -1 +1 @@ -Subproject commit 2b41478df078578fb6bf287ffa53357b99a51e4d +Subproject commit 7f650958d2168ead0730f3ae429a266e3709631c diff --git a/tools/common/time_string.hpp b/tools/common/time_string.hpp deleted file mode 100644 index 7f112e6976..0000000000 --- a/tools/common/time_string.hpp +++ /dev/null @@ -1,53 +0,0 @@ -// ---- time_string: thin wrapper around std::strftime -------- // -// -// Copyright Gennaro Prota 2006 -// -// Distributed under the Boost Software License, Version 1.0. -// (See accompanying file LICENSE_1_0.txt or copy at -// http://www.boost.org/LICENSE_1_0.txt) -// -// ------------------------------------------------------------------ -// -// $Id$ - -#ifndef BOOST_TIME_STRING_HPP_GP_20060731 -#define BOOST_TIME_STRING_HPP_GP_20060731 - -#include -#include - -namespace boost { - -// Many of the boost tools just need a quick way to obtain -// a formatted "run date" string or similar. This is one. -// -// In case of failure false is returned and result is -// unchanged. -// -inline -bool time_string(std::string & result - , const std::string & format = "%X UTC, %A %d %B %Y") -{ - // give up qualifying names and using std::size_t, - // to avoid including "config.hpp" - using namespace std; - - const int sz = 256; - char buffer [ sz ] = { 0 }; - const time_t no_cal_time ( -1 ); - time_t tod; - - const bool ok = - time ( &tod ) != no_cal_time - && strftime( buffer, sz, format.c_str(), gmtime( &tod ) ) != 0 - ; - - if (ok) - result = buffer; - - return ok; -} - -} - -#endif // include guard diff --git a/tools/regression/doc/index.html b/tools/regression/doc/index.html index 58bbd9d0e2..deeb68d48d 100644 --- a/tools/regression/doc/index.html +++ b/tools/regression/doc/index.html @@ -21,8 +21,11 @@ reports.

    -
  • Instructions for running the regression - tests
    • +
  • Instructions + for running the regression tests as part of the published regression + tests are available at the Boost web site.
    • +
  • process_jam_log.cpp - Processes the bjam outputs, creating a file named test_log.xml for each test encountered.
    • @@ -51,4 +54,4 @@ copy at www.boost.org/LICENSE_1_0.txt)

    - \ No newline at end of file + diff --git a/tools/regression/doc/instructions.html b/tools/regression/doc/instructions.html deleted file mode 100644 index bc74cc6b47..0000000000 --- a/tools/regression/doc/instructions.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - -Running Boost Regression Tests - - - - - - - - - - -
    - -boost.png (6897 bytes) - Running Boost Regression Tests -
    - -

    Requirements

    -
      -
    • Python 2.3 or later.
      - 
      • -
    • Subversion 1.4 or later.
      - 
      • -
    • At least 5 gigabytes of disk space per compiler to be tested.
      • -
    -

    Step by step instructions

    -
      -
    1. Create a new directory for the branch you want to test.
      - 
      2. -
    2. Download the - - run.py script into that directory.
      - 
      3. -
    3. Run "python run.py [options] [commands]".
      4. -
    -
    -
    - 
    commands: cleanup, collect-logs, get-source, get-tools, patch,
-regression, setup, show-revision, test, test-clean, test-process,
-test-run, update-source, upload-logs
-
-options:
-   -h, --help            show this help message and exit
-   --runner=RUNNER       runner ID (e.g. 'Metacomm')
-   --comment=COMMENT     an HTML comment file to be inserted in the
-                         reports
-   --tag=TAG             the tag for the results
-   --toolsets=TOOLSETS   comma-separated list of toolsets to test with
-   --incremental         do incremental run (do not remove previous
-                         binaries)
-   --timeout=TIMEOUT     specifies the timeout, in minutes, for a single
-                         test run/compilation
-   --bjam-options=BJAM_OPTIONS
-                         options to pass to the regression test
-   --bjam-toolset=BJAM_TOOLSET
-                         bootstrap toolset for 'bjam' executable
-   --pjl-toolset=PJL_TOOLSET
-                         bootstrap toolset for 'process_jam_log'
-                         executable
-   --platform=PLATFORM
-   --user=USER           Boost SVN user ID
-   --local=LOCAL         the name of the boost tarball
-   --force-update=FORCE_UPDATE
-                         do an SVN update (if applicable) instead of a
-                         clean checkout, even when performing a full run
-   --have-source=HAVE_SOURCE
-                         do neither a tarball download nor an SVN update;
-                         used primarily for testing script changes
-   --proxy=PROXY         HTTP proxy server address and port
-                         (e.g.'http://www.someproxy.com:3128')
-   --ftp-proxy=FTP_PROXY
-                         FTP proxy server (e.g. 'ftpproxy')
-   --dart-server=DART_SERVER
-                         the dart server to send results to
-   --debug-level=DEBUG_LEVEL
-                         debugging level; controls the amount of
-                         debugging output printed
-   --send-bjam-log       send full bjam log of the regression run
-   --mail=MAIL           email address to send run notification to
-   --smtp-login=SMTP_LOGIN
-                         STMP server address/login information, in the
-                         following form:
-                         <user>:<password>@<host>[:<port>]
-   --skip-tests=SKIP_TESTS
-                         do not run bjam; used for testing script changes
    -
    -
    -

    To test trunk use "--tag=trunk" (the default), and to test the -release use "--tag=branches/release". Or substitute any Boost tree -of your choice.

    - -
    - -

    © Copyright Rene Rivera, 2007
    -Distributed under the Boost Software License, Version 1.0. See -www.boost.org/LICENSE_1_0.txt

    - -

    Revised -November 23, 2007 -

    - - \ No newline at end of file