Update CMake documentation

doc/src/Build.txt

@@ -29,6 +29,7 @@ as described on the "Install"_Install.html doc page.
    Build_package
    Build_extras
    Build_windows
+   Build_development
 
 END_RST -->
 

doc/src/Build_basics.txt

@@ -310,6 +310,30 @@ current LAMMPS version (HTML and PDF files), from the website
 
 :line
 
+Build LAMMPS tools :h4,link(tools)
+
+Some tools described in "Auxiliary tools"_Tools.html can be built directly
+using CMake or Make.
+
+[CMake variable]:
+
+-D BUILD_TOOLS=value       # yes or no (default) :pre
+
+The generated binaries will also become part of the LAMMPS installation (see below)
+
+[Traditional make]:
+
+cd lammps/tools
+make all              # build all binaries of tools
+make binary2txt       # build only binary2txt tool
+make chain            # build only chain tool
+make micelle2d        # build only micelle2d tool
+make thermo_extract   # build only thermo_extract tool
+:pre
+
+:line
+
+
 Install LAMMPS after a build :h4,link(install)
 
 After building LAMMPS, you may wish to copy the LAMMPS executable of

doc/src/Build_cmake.txt

@@ -120,7 +120,7 @@ The argument can be preceeded or followed by various CMake
 command-line options.  Several useful ones are:
 
 -D CMAKE_INSTALL_PREFIX=path  # where to install LAMMPS executable/lib if desired
--D CMAKE_BUILD_TYPE=type      # type = Release or Debug
+-D CMAKE_BUILD_TYPE=type      # type = RelWithDebInfo (default), Release, MinSizeRel, or Debug
 -G output                     # style of output CMake generates
 -DVARIABLE=value              # setting for a LAMMPS feature to enable
 -D VARIABLE=value             # ditto, but cannot come after CMakeLists.txt dir

doc/src/Build_development.txt

@@ -0,0 +1,86 @@
+"Higher level section"_Build.html - "LAMMPS WWW Site"_lws - "LAMMPS
+Documentation"_ld - "LAMMPS Commands"_lc :c
+
+:link(lws,http://lammps.sandia.gov)
+:link(ld,Manual.html)
+:link(lc,Commands_all.html)
+
+:line
+
+Development options (CMake only) :h3
+
+The CMake build of LAMMPS has a few extra options which are useful during
+development,  testing or debugging.
+
+:line
+
+Verify compilation flags :h4,link(compilation)
+
+Sometimes it is necessary to verify the complete sequence of compilation flags
+generated by the CMake build. To enable a more verbose output during
+compilation you can use the following option.
+
+-D CMAKE_VERBOSE_MAKEFILE=value    # value = no (default) or yes :pre
+
+Another way of doing this without reconfiguration is calling make with variable VERBOSE set to 1:
+
+make VERBOSE=1 :pre
+
+:line
+
+Address, Undefined Behavior, and Thread Sanitizer Support :h4,link(sanitizer)
+
+Compilers such as GCC and Clang support generating binaries which use different
+sanitizers to detect problems in code during run-time. They can detect "memory leaks"_https://clang.llvm.org/docs/AddressSanitizer.html,
+code that runs into "undefined behavior"_https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html of the
+language and "data races"_https://clang.llvm.org/docs/ThreadSanitizer.html in threaded code.
+
+The following settings allow you enable these features if your compiler supports
+it. Please note that they come with a performance hit. However, they are
+usually faster than using tools like Valgrind.
+
+-D ENABLE_SANITIZE_ADDRESS=value    # enable Address Sanitizer, value = no (default) or yes
+-D ENABLE_SANITIZE_UNDEFINED=value  # enable Undefined Behaviour Sanitizer, value = no (default) or yes
+-D ENABLE_SANITIZE_THREAD=value     # enable Thread Sanitizer, value = no (default) or yes
+:pre
+
+:line
+
+Code Coverage and Testing :h4,link(testing)
+
+We do extensive regression testing of the LAMMPS code base on a continuous
+basis. Some of the logic to do this has been added to the CMake build so
+developers can run the tests directly on their workstation. 
+
+NOTE: this is incomplete and only represents a small subset of tests that we run
+
+-D ENABLE_TESTING=value               # enable simple run tests of LAMMPS, value = no (default) or yes
+-D LAMMPS_TESTING_SOURCE_DIR=path     # path to lammps-testing repository (option if in custom location)
+-D LAMMPS_TESTING_GIT_TAG=value       # version of lammps-testing repository that should be used, value = master (default) or custom git commit or tag
+:pre
+
+If you enable testing in the CMake build it will create an additional target called "test". You can run them with:
+
+make test
+:pre
+
+The test cases used come from the lammps-testing repository. They are
+derivatives of the examples folder with some modifications to make the run
+faster.
+
+You can also collect code coverage metrics while running the tests by enabling
+coverage support during building.
+
+-D ENABLE_COVERAGE=value  # enable coverage measurements, value = no (default) or yes :pre
+
+This will also add the following targets to generate coverage reports after running the LAMMPS executable:
+
+make test               # run tests first!
+make gen_coverage_html  # generate coverage report in HTML format
+make gen_coverage_xml   # generate coverage report in XML format
+:pre
+
+These reports require GCOVR to be installed. The easiest way to do this to install it via pip:
+
+pip install git+https://github.com/gcovr/gcovr.git :pre
+:pre

doc/src/Build_extras.txt

@@ -88,7 +88,7 @@ which GPU hardware to build for.
                           # generic (default) or intel (Intel CPU) or fermi, kepler, cypress (NVIDIA)
 -D GPU_ARCH=value         # primary GPU hardware choice for GPU_API=cuda
                           # value = sm_XX, see below
-                          # default is Cuda-compiler dependent, but typically sm_20
+                          # default is sm_30
 -D CUDPP_OPT=value        # optimization setting for GPU_API=cuda
                           # enables CUDA Performance Primitives Optimizations
                           # value = yes (default) or no
@@ -354,6 +354,9 @@ be installed on your system.
 [CMake build]:
 
 -D MESSAGE_ZMQ=value    # build with ZeroMQ support, value = no (default) or yes
+-D ZMQ_LIBRARY=path     # ZMQ library file (only needed if a custom location)
+-D ZMQ_INCLUDE_DIR=path # ZMQ include directory (only needed if a custom location)
+:pre
 
 [Traditional make]:
 
@@ -366,6 +369,7 @@ simply invoke the lib/message/Install.py script with the specified args:
 make lib-message               # print help message
 make lib-message args="-m -z"  # build with MPI and socket (ZMQ) support
 make lib-message args="-s"     # build as serial lib with no ZMQ support
+:pre
 
 The build should produce two files: lib/message/cslib/src/libmessage.a
 and lib/message/Makefile.lammps.  The latter is copied from an

doc/src/Packages_details.txt

@@ -1,4 +1,4 @@
-"Higher level section"_Packages.html - "LAMMPS WWW Site"_lws - "LAMMPS
+tion"_Packages.html - "LAMMPS WWW Site"_lws - "LAMMPS
 Documentation"_ld - "LAMMPS Commands"_lc :c
 
 :link(lws,http://lammps.sandia.gov)
@@ -1191,7 +1191,7 @@ USER-PLUMED package :link(PKG-USER-PLUMED),h4
 The fix plumed command allows you to use the PLUMED free energy plugin
 for molecular dynamics to analyze and bias your LAMMPS trajectory on
 the fly.  The PLUMED library is called from within the LAMMPS input
-script by using the "fix plumed _fix_plumed.html command.
+script by using the "fix plumed"_fix_plumed.html command.
 
 [Authors:] The "PLUMED library"_#PLUMED is written and maintained by
 Massimilliano Bonomi, Giovanni Bussi, Carlo Camiloni and Gareth