diff --git a/.gitignore b/.gitignore index 0f1b01775d..14d9dbebc9 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,7 @@ *.sif *.dll *.pyc +a.out __pycache__ Obj_* diff --git a/doc/src/Build_package.rst b/doc/src/Build_package.rst index cfabca9c48..073fedbfa8 100644 --- a/doc/src/Build_package.rst +++ b/doc/src/Build_package.rst @@ -258,10 +258,10 @@ currently installed, without listing the status of packages that are not installed. Type ``make package-update`` or ``make pu`` to overwrite src files with -files from the package sub-directories if the package is installed. -It should be used after a :doc:`patch has been applied `, -since patches only update the files in the package sub-directory, but -not the src files. +files from the package sub-directories if the package is installed. It +should be used after the checkout has been :doc:`updated or changed +withy git `, this will only update the files in the package +sub-directories, but not the copies in the src folder. Type ``make package-overwrite`` to overwrite files in the package sub-directories with src files. diff --git a/doc/src/Install.rst b/doc/src/Install.rst index e0204c0bbd..157bd32208 100644 --- a/doc/src/Install.rst +++ b/doc/src/Install.rst @@ -18,7 +18,6 @@ need the source code. Install_tarball Install_git - Install_patch These are the files and sub-directories in the LAMMPS distribution: @@ -27,6 +26,8 @@ These are the files and sub-directories in the LAMMPS distribution: +------------+-------------------------------------------+ | LICENSE | GNU General Public License (GPL) | +------------+-------------------------------------------+ +| SECURITY.md| Security Policy for the LAMMPS package | ++------------+-------------------------------------------+ | bench | benchmark problems | +------------+-------------------------------------------+ | cmake | CMake build files | diff --git a/doc/src/Install_git.rst b/doc/src/Install_git.rst index 1a07b7f917..f62bad6847 100644 --- a/doc/src/Install_git.rst +++ b/doc/src/Install_git.rst @@ -120,8 +120,11 @@ changed. How to do this depends on the build system you are using. $ make package-update # sync package files with src files $ make foo # re-build for your machine (mpi, serial, etc) - Just as described on the :doc:`Apply patch ` page, - after a patch has been installed. + to enforce consistency of the source between the src folder + and package directories. This is OK to do even if you don't + use any packages. The "make purge" command removes any deprecated + src files if they were removed by the patch from a package + sub-directory. .. warning:: diff --git a/doc/src/Install_patch.rst b/doc/src/Install_patch.rst deleted file mode 100644 index f1f37f86c2..0000000000 --- a/doc/src/Install_patch.rst +++ /dev/null @@ -1,96 +0,0 @@ -Applying patches ----------------- - -It is easy to stay current with the most recent LAMMPS patch releases -if you use git to track the LAMMPS development. Instructions for -how to stay current are on the -:doc:`Download the LAMMPS source with git ` page. - -If you prefer to download a tarball, as described on the -:doc:`tarball download ` page, you can stay current by -downloading "patch files" when new patch releases are made. A link to -a patch file is posted on the -`bug fixes and new feature page `_ -of the LAMMPS website, along -with a list of changed files and details about what is in the new patch -release. This page explains how to apply the patch file to your local -LAMMPS directory. - -.. note:: - - You should not apply patch files to a local git checkout of - LAMMPS, only to an unpacked tarball. Use git commands to - update such a version of the LAMMPS source code. - -Here are the steps to apply a patch file. Note that if your version -of LAMMPS is several patch releases behind, you need to apply all the -intervening patch files in succession to bring your version of LAMMPS -up to date. - -* Download the patch file. You may have to shift-click in your browser - to download the file instead of display it. Patch files have names - like patch.12Dec16. -* Put the patch file in your top-level LAMMPS directory, where the - LICENSE and README files are. -* Apply the patch by typing the following command from your top-level - LAMMPS directory, where the redirected file is the name of the patch - file. - - .. code-block:: bash - - $ patch -bp1 < patch.12Dec16 - -* A list of updated files print out to the screen. The -b switch - creates backup files of your originals (e.g. src/force.cpp.orig), so - you can manually undo the patch if something goes wrong. - -* Once you have updated your local files you need to re-build LAMMPS. - If you are applying several patches successively, you only need to - do the rebuild once at the end. How to do it depends on the build - system you are using. - - .. tabs:: - - .. tab:: CMake build - - Change to your build folder and type: - - .. code-block:: bash - - cmake . --build - - CMake should auto-detect whether it needs to re-run the CMake - configuration step and otherwise redo the build for all files - that have been changed or files that depend on changed files. - In case some build options have been changed or renamed, you - may have to update those by running: - - .. code-block:: bash - - cmake . - - and then rebuild. - - .. tab:: Traditional make - - Switch to the src directory and type: - - .. code-block:: bash - - $ make purge # remove any deprecated src files - $ make package-update # sync package files with src files - $ make foo # re-build for your machine (mpi, serial, etc) - - to enforce consistency of the source between the src folder - and package directories. This is OK to do even if you don't - use any packages. The "make purge" command removes any deprecated - src files if they were removed by the patch from a package - sub-directory. - - .. warning:: - - If you wish to edit/change a src file that is from a package, - you should edit the version of the file inside the package - sub-directory with src, then re-install the package. The - version in the source directory is merely a copy and will be - wiped out if you type "make package-update". diff --git a/doc/src/Install_tarball.rst b/doc/src/Install_tarball.rst index 921ce8785a..caa8f700a9 100644 --- a/doc/src/Install_tarball.rst +++ b/doc/src/Install_tarball.rst @@ -47,15 +47,3 @@ release. .. _git: https://github.com/lammps/lammps/releases ----------- - -If you download a current LAMMPS tarball, one way to stay current as -new patch tarballs are released, is to download a patch file which you -can apply to your local directory to update it for each new patch -release. (Or of course you could just download the newest tarball -periodically.) - -The patch files are posted on the `bug and feature page `_ of the -website, along with a list of changed files and details about what is -in the new patch release. Instructions for applying a patch file are -on the :doc:`Install patch ` page.