doc: say that CMake is the default build system (#3420)

Co-authored-by: Ronak Buch <[email protected]>

Author: 2 people

CMakeLists.txt

@@ -13,13 +13,13 @@
 cmake_minimum_required(VERSION 3.4)
 
 # Print warning
-message("#################################################################")
-message("# The CMake build system is currently a beta version.           #")
-message("# Please let us know if you experience any problems by opening  #")
-message("# an issue on our GitHub (https://github.com/UIUC-PPL/charm),   #")
-message("# with the below configuration information.                     #")
-message("# You can run './buildold' to use the previous build system.    #")
-message("#################################################################")
+message("##################################################################")
+message("# The CMake build system may not support advanced build options. #")
+message("# Please let us know if you experience any problems by opening   #")
+message("# an issue on our GitHub (https://github.com/UIUC-PPL/charm),    #")
+message("# with the below configuration information.                      #")
+message("# You can run './buildold' to use the previous build system.     #")
+message("##################################################################")
 
 if(CMAKE_VERSION VERSION_GREATER 3.12 OR CMAKE_VERSION VERSION_EQUAL 3.12)
   cmake_policy(SET CMP0075 OLD)

doc/charm++/manual.rst

@@ -11271,9 +11271,9 @@ Downloading Charm++
 
 Charm++ can be downloaded using one of the following methods:
 
--  From Charm++ website - The current stable version (source code and
+-  From the Charm++ website - The current stable version (source code and
    binaries) can be downloaded from our website at
-   *http://charm.cs.illinois.edu/software*.
+   *https://charm.cs.illinois.edu/software*.
 
 -  From source archive - The latest development version of Charm++ can
    be downloaded from our source archive using *git clone
@@ -11292,20 +11292,31 @@ Installation
 A typical prototype command for building Charm++ from the source code
 is:
 
-``./build <TARGET> <TARGET ARCHITECTURE> [OPTIONS]`` where,
+.. code-block:: bash
+
+   $ ./build <TARGET> <TARGET ARCHITECTURE> [OPTIONS]
+
+where,
 
-TARGET
+``TARGET``
    is the framework one wants to build such as *charm++* or *AMPI*.
 
-TARGET ARCHITECTURE
+``TARGET ARCHITECTURE``
    is the machine architecture one wants to build for such as
    *netlrts-linux-x86_64*, *pamilrts-bluegeneq* etc.
 
-OPTIONS
+``OPTIONS``
    are additional options to the build process, e.g. *smp* is used to
    build a shared memory version, *-j8* is given to build in parallel
    etc.
 
+.. note::
+
+   Starting from version 7.0, Charm++ uses the CMake-based build system
+   when building with the ``./build`` command. To use the old configure-based
+   build system, you can build with the ``./buildold`` command with the same
+   options. We intend to remove the old build system in Charm++ 7.1.
+
 In Table :numref:`tab:buildlist`, a list of build
 commands is provided for some of the commonly used systems. Note that,
 in general, options such as *smp*, ``--with-production``, compiler
@@ -11362,13 +11373,13 @@ path would be ``netlrts-linux-x86_64/tmp``. On Linux and macOS, the tmp
 symlink in the top-level charm directory also points to the tmp
 directory of the most recent build.
 
-Alternatively, CMake can be used for configuring and building Charm++.
+Alternatively, CMake can be used directly for configuring and building Charm++.
 You can use ``cmake-gui`` or ``ccmake`` for an overview of available
 options. Note that some are only effective when passed with ``-D`` from
 the command line while configuring from a blank slate. To build with all
 defaults, ``cmake .`` is sufficient, though invoking CMake from a
 separate location (ex:
-``mkdir mybuild && cd mybuild && cmake ../charm``) is recommended.
+``mkdir mybuild && cd mybuild && cmake ..``) is recommended.
 Please see Section :numref:`sec:cmakeinstall` for building Charm++
 directly with CMake.
 
@@ -11419,9 +11430,8 @@ select another version with the ``@`` option (for example,
 Installation with CMake
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-As an experimental feature, Charm++ can be installed with the CMake tool,
-version 3.4 or newer.
-This is currently supported on Linux and Darwin, but not on Windows.
+Charm++ can be installed directly with the CMake tool,
+version 3.4 or newer, without using the ``./build`` command.
 
 After downloading and unpacking Charm++, it can be installed in the following way:
 
@@ -11442,46 +11452,40 @@ For example, to build Charm++ and AMPI on top of the MPI layer with SMP, the fol
 
    $ cmake .. -DNETWORK=mpi -DSMP=on -DTARGET=AMPI
 
-To simplify building with CMake, the `buildcmake` command is a simple wrapper around cmake
-that supports many of the options that `build` supports.
-
-.. code-block:: bash
-
-   $ ./buildcmake AMPI netlrts-linux-x86_64 smp --with-production
 
 Charm++ installation directories
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The main directories in a Charm++ installation are:
 
-charm/bin
+``charm/bin``
    Executables, such as charmc and charmrun, used by Charm++.
 
-charm/doc
+``charm/doc``
    Documentation for Charm++, such as this document. Distributed as
-   LaTeX source code; HTML and PDF versions can be built or downloaded
-   from our web site.
+   reStructuredText (RST or ReST) source code; HTML and PDF versions can be
+   built or downloaded from our web site.
 
-charm/include
+``charm/include``
    The Charm++ C++ and Fortran user include files (.h).
 
-charm/lib
+``charm/lib``
    The static libraries (.a) that comprise Charm++.
 
-charm/lib_so
+``charm/lib_so``
    The shared libraries (.so/.dylib) that comprise Charm++, if Charm++
    is compiled with the ``-build-shared`` option.
 
-charm/examples
+``charm/examples``
    Example Charm++ programs.
 
-charm/src
+``charm/src``
    Source code for Charm++ itself.
 
-charm/tmp
+``charm/tmp``
    Directory where Charm++ is built.
 
-charm/tests
+``charm/tests``
    Test Charm++ programs used by autobuild.
 
 Reducing disk usage

doc/conf.py

@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Charm++'
-copyright = '2020, PPL'
+copyright = '2021, PPL'
 author = 'PPL'
 
 # The short X.Y version