ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

reformat colvars related docs. add false positive for spellchecker

Browse Source
This commit is contained in:
Axel Kohlmeyer
2022-12-27 21:15:33 -05:00
parent d10e7195dc
commit 52fcd08e1c
2 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/src/Build_extras.rst
View File

@ -1347,16 +1347,20 @@ module included in the LAMMPS source distribution.
$ make lib-colvars # print help message $ make lib-colvars # print help message
$ make lib-colvars args="-m mpi" # build with default MPI compiler (settings as with "make mpi") $ make lib-colvars args="-m mpi" # build with default MPI compiler (settings as with "make mpi")
$ make lib-colvars args="-m serial" # build with GNU g++ compiler (settings as with "make serial") $ make lib-colvars args="-m serial" # build with GNU g++ compiler (settings as with "make serial")
The "machine" argument of the "-m" flag is used to find a The "machine" argument of the "-m" flag is used to find a
``Makefile.machine`` file to use as build recipe. If such recipe does ``Makefile.machine`` file to use as build recipe. If such recipe does
not already exist in ``lib/colvars``, suitable settings will be not already exist in ``lib/colvars``, suitable settings will be
auto-generated consistent with those used in the core LAMMPS makefiles. auto-generated consistent with those used in the core LAMMPS makefiles.
Please note that Colvars uses the Lepton library, which is enabled in
the LEPTON package; if you use anything other than the ``make .. versionchanged:: TBD
lib-colvars`` command, please make sure to build Lepton beforehand.
Please note that Colvars uses the Lepton library, which is now
included with the LEPTON package; if you use anything other than
the ``make lib-colvars`` command, please make sure to :ref:`build
Lepton beforehand <lepton>`.
Optional flags may be specified as environment variables: Optional flags may be specified as environment variables:
@ -1367,8 +1371,8 @@ module included in the LAMMPS source distribution.
The build should produce two files: the library The build should produce two files: the library
``lib/colvars/libcolvars.a`` and the specification file ``lib/colvars/libcolvars.a`` and the specification file
``lib/colvars/Makefile.lammps``. The latter is auto-generated, and ``lib/colvars/Makefile.lammps``. The latter is auto-generated,
normally does not need to be edited. and normally does not need to be edited.
---------- ----------

2
doc/utils/sphinx-config/false_positives.txt
View File

@ -2235,7 +2235,7 @@ msm
msmflag msmflag
msse msse
msst msst
Mtchell MtD
Mth Mth
mtk mtk
Mtotal Mtotal