From 1c8b7022a3651a056391a19b595416a97ddcf8be Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Thu, 20 Feb 2020 17:33:57 +0100 Subject: [PATCH] update documentation for the conventional build --- doc/src/Build_make.rst | 40 ++++++++++++++------- doc/utils/sphinx-config/false_positives.txt | 1 + 2 files changed, 28 insertions(+), 13 deletions(-) diff --git a/doc/src/Build_make.rst b/doc/src/Build_make.rst index f88bd8b1b2..a6caa7cd58 100644 --- a/doc/src/Build_make.rst +++ b/doc/src/Build_make.rst @@ -7,15 +7,27 @@ src/MAKE/MACHINES, src/MAKE/OPTIONS, or src/MAKE/MINE directory (see below). It can include various options for customizing your LAMMPS build with a number of global compilation options and features. -To include LAMMPS packages (i.e. optional commands and styles) you -must install them first, as discussed on the :doc:`Build package ` doc page. If the packages require -provided or external libraries, you must build those libraries before -building LAMMPS. Building :doc:`LAMMPS with CMake ` can -automate all of this for many types of machines, especially -workstations, desktops and laptops, so we suggest you try it first. +Those makefiles are written for and tested with GNU make and may not +be compatible with other make programs. In most cases, if the "make" +program is not GNU make, then it will be installed as "gmake". If +GNU make or a compatible make is not available, you may have to first +install it. These makefiles and the scripts they are calling expect +a few additional tools to be available and functioning. -These commands perform a default LAMMPS build, producing the LAMMPS -executable lmp\_serial or lmp\_mpi in lammps/src: + * a Bourne shell compatible "Unix" shell program (often this is bash) + * a few shell utilities: ls, mv, ln, rm, grep, sed, tr, cat, touch, diff, dirname + * python (optional, required for "make lib-XXX" in the src folder) + +To include LAMMPS packages (i.e. optional commands and styles) you +must enable them first, as discussed on the :doc:`Build package +` doc page. If a packages requires (provided or +external) libraries, you must build those libraries before building +LAMMPS. Building :doc:`LAMMPS with CMake ` can automate +much of this for many types of machines, especially workstations, +desktops and laptops, so we suggest you try it first. + +The commands below perform a default LAMMPS build, producing the LAMMPS +executable lmp\_serial and lmp\_mpi in lammps/src: .. code-block:: bash @@ -42,14 +54,16 @@ re-compiled. .. note:: - When you build LAMMPS for the first time, a long list of \*.d - files will be printed out rapidly. This is not an error; it is the - Makefile doing its normal creation of dependencies. - + Before the actual compilation starts, LAMMPS will perform several + steps to collect information from the configuration and setup that + is then embedded into the executable. When you build LAMMPS for + the first time, it will also compile a tool to quickly assemble + a list of dependencies, that are required for the make program to + correctly detect which parts need to be recompiled after changes + were made to the sources. ---------- - The lammps/src/MAKE tree contains all the Makefile.machine files included in the LAMMPS distribution. Typing "make machine" uses Makefile.machine. Thus the "make serial" or "make mpi" lines above diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index 6761730ce5..e8c7223f70 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -613,6 +613,7 @@ dimgray dipolar dir Direc +dirname dirs discoverable discretization