From 64e1c28e88181f4f475cb2f12757496d3b90ae06 Mon Sep 17 00:00:00 2001 From: Matthias Maier Date: Mon, 21 Jul 2014 18:13:44 +0200 Subject: [PATCH] Documentation: Remove references to svn Remove references to svn's $Id$ in the headers and replace references to the old subversion repository in various html files --- doc/developers/testsuite.html | 107 ++++++++++------------ doc/developers/title.html | 2 +- doc/developers/toc.html | 2 +- doc/developers/writing-documentation.html | 2 +- doc/users/cmakelists.html | 2 +- doc/users/index.html | 2 +- doc/users/navbar.html | 2 +- doc/users/title.html | 2 +- doc/users/toc.html | 2 +- 9 files changed, 58 insertions(+), 65 deletions(-) diff --git a/doc/developers/testsuite.html b/doc/developers/testsuite.html index c7e0486295..6a4280ea02 100644 --- a/doc/developers/testsuite.html +++ b/doc/developers/testsuite.html @@ -5,7 +5,7 @@ The deal.II Testsuite - + @@ -16,7 +16,7 @@

The deal.II Testsuite

- The deal.II testsuite consists of two parts: + The deal.II testsuite consists of two parts: build tests and the regression testsuite. While the build tests are used to check that the @@ -28,16 +28,17 @@

- deal.II has a testsuite that currently has (mid-2014), some 3,400 - small programs (growing by roughly one per day) that we run every - time we make a change to make sure that no existing functionality is - broken. The expected output for every test is stored in an output - file, and when you run a test you are notified if a test produces - different output. These days, every time we add a significant piece - of functionality, we add at least one new test to the testsuite, and - we also do so if we fix a bug, in both cases to make sure that future - changes do not break what we have just checked in. Machines running - tests send results back home and these are then converted into + deal.II has a testsuite that has, at the time this article is written + (mid-2013), some 2,900 small programs (growing by roughly one per day) + that we run every time we make a change to make sure that no existing + functionality is broken. The expected output for every test is stored in + an *.output, and when you run a test you are notified if a + test produces different output. These days, every time we add a + significant piece of functionality, we add at least one new test to the + testsuite, and we also do so if we fix a bug, in both cases to make sure + that future changes do not break what we have just checked in. Machines + running tests send results + back home and these are then converted into a webpage showing the status of our regression tests.

@@ -46,6 +47,10 @@
  1. Quick instructions
  2. Setting up the testsuite
  3. +
      +
    1. Downloading the testsuite
    2. +
    3. Preparing the testsuite
    4. +
  4. Running the testsuite
    1. How to interpret the output
    2. @@ -66,8 +71,8 @@
  5. Submitting test results
  6. Build tests
  7. -
      -
    1. Dedicated build tests
    2. +
        +
      1. Dedicated build tests
    @@ -78,12 +83,10 @@

    If you're impatient, use the following commands:

    -$ mkdir new_directory
    -$ cd new_directory
    -$ svn checkout https://svn.dealii.org/trunk .
    -$ mkdir build
    -$ cd build
    -$ cmake ../deal.II
    +$ git clone https://github.com/dealii/dealii
    +$ mkdir dealii/build
    +$ cd dealii/build
    +$ cmake ..
     $ make -j16
     $ make -j16 setup_tests
     $ ctest -j16
    @@ -95,16 +98,23 @@ $ ctest -j16
         
         

    Setting up the testsuite

    -

    In order to run it, you need to checkout the git repository with - the development version of deal.II. If you haven't already done this - clone the repository via: +

    In order to run it, you need to download and set up the testsuite + first. The following paragraphs detail how to do that. +

    + + +

    Downloading the testsuite

    + +

    + Just download the current development sources:

    -$ git clone https://github.com/dealii/dealii.git
    +$ git clone https://github.com/dealii/dealii
     
    - More information about the git repository is available on the homepage.

    + +

    Preparing the testsuite

    +

    To enable the testsuite, configure and build deal.II in a build directory as normal (installation is not necessary). After that you @@ -590,7 +600,7 @@ category/test.expect=run.output

     // ---------------------------------------------------------------------
     //
    -// Copyright (C) 2013 by the deal.II Authors
    +// Copyright (C) 2014 by the deal.II Authors
     //
     // This file is part of the deal.II library.
     //
    @@ -689,19 +699,6 @@ $ ctest -V -R "category/my_new_test"
     

    - -

    Checking in

    - -

    - Tests are a way to make sure everything keeps working. If they aren't - automated, they are no good. We are therefore very interested in - getting new tests. Talk to us in the discussion group! Writing - testcases is a worthy and laudable task, and we would like to - encourage it by giving people the opportunity to contribute! -

    - - -

    Adding new categories

    @@ -718,8 +715,6 @@ INCLUDE(${DEAL_II_TARGET_CONFIG}) DEAL_II_PICKUP_TESTS()
    - -

    Submitting test results

    @@ -752,9 +747,7 @@ ctest -D<variable>=<value> [...] script:
     CTEST_SOURCE_DIRECTORY
    -  - The source directory of deal.II (usually ending in "[...]/deal.II"
    -    (equivalent to https://svn.dealii.org/trunk/deal.II)
    -    Note: This is _not_ the test directory ending in "[...]/tests"
    +  - The source directory of deal.II
       - If unspecified, "../deal.II" and "../../" relative to the location
         of this script is used. If this is not a source directory, an error
         thrown.
    @@ -776,16 +769,17 @@ TRACK
       - The track the test should be submitted to. Defaults to "Experimental".
         Possible values are:
     
    -    "Experimental"     - all tests that are not specifically "build" tests
    -                         should go into this track
    +    "Experimental"     - all tests that are not specifically "build" or
    +                         "regression" tests should go into this track
     
    -    "Build Tests"      - Build tests that configure and build in a clean
    -                         directory and run exactly all build tests matching
    -                         "build_tests/.*"
    +    "Build Tests"      - Build tests that configure and build in a
    +                         clean directory and run the build tests
    +                         "build_tests/*"
     
    -    "Regression Tests" - Reserved for the regression tester
    +    "Nightly"          - Reserved for nightly regression tests for
    +                         build bots on various architectures
     
    -    "Continuous"       - Reserved for the regression tester
    +    "Regression Tests" - Reserved for the regression tester
     
     CONFIG_FILE
       - A configuration file (see docs/development/Config.sample)
    @@ -825,11 +819,10 @@ MAKEOPTS
           users with configurations not found on the CDash page to
           participate. Assuming you checked out deal.II into the directory
    -      deal.II, running it is as simple as:
    +      dealii, running it is as simple as:
     
    -cd deal.II
    -mkdir build
    -cd build
    +mkdir dealii/build
    +cd dealii/build
     ctest -j4 -S ../cmake/scripts/run_buildtest.cmake
     

    @@ -843,7 +836,7 @@ ctest -j4 -S ../cmake/scripts/run_buildtest.cmake

    Note: Build tests require the designated build directory to be - completely empty If you want to specify a build configuration for + completely empty. If you want to specify a build configuration for cmake use a configuration file to preseed the cache as explained above:

    diff --git a/doc/developers/title.html b/doc/developers/title.html
    index 6ab07ee6b2..34e6b6a14d 100644
    --- a/doc/developers/title.html
    +++ b/doc/developers/title.html
    @@ -5,7 +5,7 @@
       
       deal.II information for developers
       
    -  
    +  
       
       
       
    diff --git a/doc/developers/toc.html b/doc/developers/toc.html
    index 0a3f5c8051..1c977b9296 100644
    --- a/doc/developers/toc.html
    +++ b/doc/developers/toc.html
    @@ -5,7 +5,7 @@
       
       The deal.II Development Page
       
    -  
    +  
       
       
       
    diff --git a/doc/developers/writing-documentation.html b/doc/developers/writing-documentation.html
    index 23d02b9869..463a344f64 100644
    --- a/doc/developers/writing-documentation.html
    +++ b/doc/developers/writing-documentation.html
    @@ -5,7 +5,7 @@
       
       Writing documentation
       
    -  
    +  
       
       
       
    diff --git a/doc/users/cmakelists.html b/doc/users/cmakelists.html
    index d020fde46a..9423d46296 100644
    --- a/doc/users/cmakelists.html
    +++ b/doc/users/cmakelists.html
    @@ -641,7 +641,7 @@ $ cmake .
     
     ###
     #
    -#  Successfully set up project  step-1  with  deal.II-99.99.svn30300  found at
    +#  Successfully set up project  step-1  with  deal.II-8.0
     #      /usr
     #
     #  CMAKE_BUILD_TYPE:         Debug
    diff --git a/doc/users/index.html b/doc/users/index.html
    index 92cb17605c..87e15da06f 100644
    --- a/doc/users/index.html
    +++ b/doc/users/index.html
    @@ -7,7 +7,7 @@
       
       
       
    -  
    +  
       
       
     
    diff --git a/doc/users/navbar.html b/doc/users/navbar.html
    index ed2ca4996d..f2c4b469c5 100644
    --- a/doc/users/navbar.html
    +++ b/doc/users/navbar.html
    @@ -6,7 +6,7 @@
       deal.II Development Navigation Bar
       
       
    -  
    +  
       
       
       
    diff --git a/doc/users/title.html b/doc/users/title.html
    index 49b2ec9f19..f11a7e4082 100644
    --- a/doc/users/title.html
    +++ b/doc/users/title.html
    @@ -6,7 +6,7 @@
       deal.II information for users
       
       
    -  
    +  
       
       
       
    diff --git a/doc/users/toc.html b/doc/users/toc.html
    index 06e4e6258e..8725a7ef0e 100644
    --- a/doc/users/toc.html
    +++ b/doc/users/toc.html
    @@ -6,7 +6,7 @@
       The deal.II Development Page
       
       
    -  
    +  
       
       
       
    -- 
    2.39.5