Revision: 76032
http://sourceforge.net/p/brlcad/code/76032
Author: brlcad
Date: 2020-06-05 07:09:04 +0000 (Fri, 05 Jun 2020)
Log Message:
-----------
document the different test targets and pgo build flags. try to reduce the
language a bit (much more overdue, but later.
Modified Paths:
--------------
brlcad/trunk/INSTALL
brlcad/trunk/README
Modified: brlcad/trunk/INSTALL
===================================================================
--- brlcad/trunk/INSTALL 2020-06-05 06:40:40 UTC (rev 76031)
+++ brlcad/trunk/INSTALL 2020-06-05 07:09:04 UTC (rev 76032)
@@ -52,35 +52,32 @@
to source code distributions of BRL-CAD.
For the impatient or simplistic, the following steps should compile,
-test, and install an optimized BRL-CAD quickly into the /usr/brlcad/rel-X.Y.Z
-directory if CMake is installed on your system:
+test, and install an optimized BRL-CAD quickly into the
+/usr/brlcad/rel-VERSION directory if CMake is alrady installed:
- gunzip brlcad-X.Y.Z.tar.gz
- tar -xvf brlcad-X.Y.Z.tar
- mkdir brlcad-build
- cd brlcad-build
- cmake ../brlcad-X.Y.Z -DBRLCAD_BUNDLED_LIBS=ON -DCMAKE_BUILD_TYPE=Release
- make
- make benchmark
- make regress
- make install # as root, e.g. sudo make install
+ tar -zxvf brlcad-VERSION.tar
+ mkdir brlcad-VERSION/build
+ cd brlcad-VERSION/build
+ cmake .. -DBRLCAD_BUNDLED_LIBS=ON -DCMAKE_BUILD_TYPE=Release
+ make -j4
+ make check
+ make install
-If any of the listed steps fail, then something unexpected happened.
-See the REPORTING PROBLEMS section of this document to report the
-problem or the INSTALLING FROM SOURCE section for more comprehensive
+See the REPORTING PROBLEMS section of this document to report any
+problems or the INSTALLING FROM SOURCE section for more comprehensive
instructions.
-Once installed, add /usr/brlcad/rel-X.Y.Z/bin to your path, and you should be
+Once installed, add /usr/brlcad/rel-VERSION/bin to your path, and you should be
able to run any of the 400+ applications that constitute BRL-CAD. For
example, to run the MGED solid modeler:
-PATH=/usr/brlcad/rel-X.Y.Z/bin:$PATH ; export PATH
+PATH=/usr/brlcad/rel-VERSION/bin:$PATH ; export PATH
mged
If you use tcsh or another C-shell based command shell, use this
instead:
-set path=( /usr/brlcad/rel-X.Y.Z/bin $path ) ; rehash
+set path=( /usr/brlcad/rel-VERSION/bin $path ) ; rehash
mged
@@ -126,9 +123,10 @@
Mac OS X Disk Mounting Image:
Mount the .dmg and run the Installer .pkg contained therein. This
-will install into /usr/brlcad/rel-X.Y.Z and will only require confirming that
-your environment is set up properly (i.e. add /usr/brlcad/rel-X.Y.Z/bin to your
-path) as described in the Quick Installation section.
+will install into /usr/brlcad/rel-X.Y.Z and will only require
+confirming that your environment is set up properly (i.e. add
+/usr/brlcad/rel-X.Y.Z/bin to your path) as described in the Quick
+Installation section.
INSTALLING FROM SOURCE
@@ -242,6 +240,14 @@
-DBRLCAD_FLAGS_OPTIMIZATION=ON
+Profile-guided optimization builds are possible via two-pass
+compilation. Compile with this flag set, run the benchmark suite,
+clean the build, and then compile again with this flag set. Supported
+compilers will utilize data from the first pass to guide optimization,
+typically resulting in a significant performance increase:
+
+ -DBRLCAD_PGO=ON
+
See the CONFIGURATION OPTIONS below for more details on all of the
possible settings.
@@ -287,20 +293,32 @@
TESTING FUNCTIONALITY
---------------------
-To test BRL-CAD before installation, you can run the BRL-CAD benchmark.
-The benchmark will report if the results are correct, testing a
-majority of the core functionality of BRL-CAD in addition to testing
-your system's performance:
+The primary build target to validate a compilation of BRL-CAD is:
+ make check
+
+That runs a trio of test sets including "benchmark", "regress", and
+"unit". The first set is a performance test that also validates
+whether ray tracing behavior is correct:
+
make benchmark
-Note that the benchmark target will build ONLY the pieces required for
-the benchmark tests, unless a general make has already been performed.
-For more testing, you can run the regression test suite:
+The second test set is our regression tests that run a host of
+rigorous integration tests and validate essential behavior:
make regress
+The third set runs unit tests that validate low-level behavior in
+BRL-CAD's core libraries:
+ make unit
+
+Last but not least, one may simply run all available tests, though
+note that some tests will intentionally fail:
+
+ make test
+
+
POST-INSTALLATION
-----------------
Modified: brlcad/trunk/README
===================================================================
--- brlcad/trunk/README 2020-06-05 06:40:40 UTC (rev 76031)
+++ brlcad/trunk/README 2020-06-05 07:09:04 UTC (rev 76032)
@@ -69,34 +69,21 @@
COMPILE AND INSTALL
-------------------
-See the INSTALL file for details on configuring, compiling, and
-installing BRL-CAD. In order to compile and install BRL-CAD from a
-source distribution, the build tool CMake is required - see the website
-at http://www.cmake.org for source and binary installers. CMake is also
-available in many Linux and *BSD distributions.
+In order to compile and install BRL-CAD from a source distribution,
+the CMake ( http://www.cmake.org ) configuration tool is requird.
-Once CMake is installed, the following steps may be taken for a full
-default install (starting with a source tarball):
+The following steps should result in a successful install:
- tar -xvzf brlcad-X.Y.Z.tar.gz
- mkdir brlcad-build
- cd brlcad-build
- cmake ../brlcad-X.Y.Z
- make
+ tar -xvzf brlcad-VERSION.tar.gz
+ mkdir brlcad-VERSION/build
+ cd brlcad-VERSION/build
+ cmake .. -DBRLCAD_ENABLE_STRICT=OFF -DCMAKE_BUILD_TYPE=Release
+ make -j4
make install
-where "X.Y.Z" is the version number of BRL-CAD. For those who prefer
-a curses interface, substitute ccmake for cmake above. If the graphical
-interface available from CMake is installed cmake-gui may be
-substituted for cmake. These interfaces will display the various
-configuration options available when building BRL-CAD, or the options
-may be set directly via command line -D options.
-The configure wrapper script may be substituted for cmake in the above
-steps for a more autotools-like configuration experience.
+See the INSTALL file for explanation of the various configuration
+options available when building BRL-CAD.
-Users on multiprocessor systems will be able to speed up their builds
-by passing the -j option to make (e.g. make -j4, assuming GNU make).
-
Once the build completes and assuming you have proper filesystem
permissions, you should be able to begin the installation by running
the "make install" . By default, the package is configured to install
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
