forked from lijiext/lammps
remove references and docs about using subversion to download LAMMPS
This commit is contained in:
Axel Kohlmeyer
parent
ff316aa4d0
commit
4ff0279bde
|
|
@ -122,7 +122,7 @@ are already included. Likewise, if a package is excluded, other files
|
|||
dependent on that package are also excluded.
|
||||
|
||||
When you download a LAMMPS tarball or download LAMMPS source files
|
||||
from the Git or SVN repositories, no packages are pre-installed in the
|
||||
from the git repository, no packages are pre-installed in the
|
||||
src directory.
|
||||
|
||||
.. note::
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ changes or additions you have made to LAMMPS into the official LAMMPS
|
|||
distribution. It uses the process of updating this very tutorial as
|
||||
an example to describe the individual steps and options. You need to
|
||||
be familiar with git and you may want to have a look at the
|
||||
`Git book <http://git-scm.com/book/>`_ to reacquaint yourself with some
|
||||
`git book <http://git-scm.com/book/>`_ to reacquaint yourself with some
|
||||
of the more advanced git features used below.
|
||||
|
||||
As of fall 2016, submitting contributions to LAMMPS via pull requests
|
||||
|
|
|
|||
|
|
@ -19,7 +19,6 @@ need the source code.
|
|||
|
||||
Install_tarball
|
||||
Install_git
|
||||
Install_svn
|
||||
Install_patch
|
||||
|
||||
These are the files and sub-directories in the LAMMPS distribution:
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@ Applying patches
|
|||
================
|
||||
|
||||
It is easy to stay current with the most recent LAMMPS patch releases
|
||||
if you use git or SVN to track LAMMPS development. Instructions for
|
||||
how to stay current are on the :doc:`Install git <Install_git>` and
|
||||
:doc:`Install svn <Install_svn>` doc pages.
|
||||
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 <Install_git>` page.
|
||||
|
||||
If you prefer to download a tarball, as described on the :doc:`Install git <Install_tarball>` doc page, you can stay current by
|
||||
downloading "patch files" when new patch releases are made. A link to
|
||||
|
|
@ -15,9 +15,9 @@ LAMMPS directory.
|
|||
|
||||
.. note::
|
||||
|
||||
You should not apply patch files to a local git or SVN repo of
|
||||
LAMMPS, only to an unpacked tarball. Use git and SVN commands to
|
||||
update repo versions of LAMMPS.
|
||||
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
|
||||
|
|
|
|||
|
|
@ -1,97 +0,0 @@
|
|||
Download source via SVN
|
||||
=======================
|
||||
|
||||
.. warning::
|
||||
|
||||
As of Oct 2016, SVN support is now implemented via a
|
||||
git-to-subversion interface service on GitHub and no longer through a
|
||||
mirror of the internal SVN repository at Sandia.
|
||||
|
||||
You must have the `Subversion (SVN) client software <svn_>`_ installed on
|
||||
your system to communicate with the Git server in this mode.
|
||||
|
||||
.. _svn: http://subversion.apache.org
|
||||
|
||||
|
||||
|
||||
You can follow LAMMPS development on 3 different SVN branches:
|
||||
|
||||
* **stable** : this branch is updated with every stable release
|
||||
* **unstable** : this branch is updated with every patch release
|
||||
* **master** : this branch continuously follows ongoing development
|
||||
|
||||
The corresponding command lines to do an initial checkout are as
|
||||
follows. (Note that unlike Git, you must perform a separate checkout
|
||||
into a unique directory for each of the 3 branches.)
|
||||
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
svn checkout https://github.com/lammps/lammps.git/branches/unstable mylammps
|
||||
svn checkout https://github.com/lammps/lammps.git/branches/stable mylammps
|
||||
svn checkout https://github.com/lammps/lammps.git/trunk mylammps
|
||||
|
||||
where "mylammps" is the name of the directory you wish to create on
|
||||
your machine.
|
||||
|
||||
Once the command completes, your directory will contain the same files
|
||||
as if you unpacked a current LAMMPS tarball, with the exception, that
|
||||
the HTML documentation files are not included. They can be fetched
|
||||
from the LAMMPS website by typing "make fetch" in the doc directory.
|
||||
Or they can be generated from the content provided in doc/src by
|
||||
typing "make html" from the doc directory.
|
||||
|
||||
After initial checkout, as bug fixes and new features are added to
|
||||
LAMMPS, as listed on :doc:`this page <Errors_bugs>`, you can stay
|
||||
up-to-date by typing the following SVN commands from within the
|
||||
"mylammps" directory:
|
||||
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
svn update
|
||||
|
||||
You can also check if there are any updates by typing:
|
||||
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
svn -qu status
|
||||
|
||||
Doing an "update" will not change any files you have added to the
|
||||
LAMMPS directory structure. It will also not change any existing
|
||||
LAMMPS files you have edited, unless those files have changed in the
|
||||
repository. In that case, SVN will attempt to merge the new
|
||||
repository file with your version of the file and tell you if there
|
||||
are any conflicts. See the SVN documentation for details.
|
||||
|
||||
Please refer to the `subversion client support help pages on GitHub <https://help.github.com/articles/support-for-subversion-clients>`_
|
||||
if you want to use advanced features like accessing particular
|
||||
previous release versions via tags.
|
||||
|
||||
Once you have updated your local files with an "svn update" (or "svn
|
||||
co"), you still need to re-build LAMMPS if any source files have
|
||||
changed. To do this, you should cd to the src directory and type:
|
||||
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
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)
|
||||
|
||||
just as described on the :doc:`Install patch <Install_patch>` doc page,
|
||||
after a patch has been installed.
|
||||
|
||||
.. warning::
|
||||
|
||||
If you wish to edit/change a source 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 src
|
||||
directory is merely a copy and will be wiped out if you type "make
|
||||
package-update".
|
||||
|
||||
The LAMMPS GitHub project is managed by Christoph Junghans (LANL,
|
||||
junghans at lanl.gov), Axel Kohlmeyer (Temple U, akohlmey at
|
||||
gmail.com) and Richard Berger (Temple U, richard.berger at
|
||||
temple.edu).
|
||||
|
|
@ -19,7 +19,7 @@ sub-directories and optionally 2 PDF files and 2 e-book format files:
|
|||
If you downloaded LAMMPS as a tarball from the web site, all these
|
||||
directories and files should be included.
|
||||
|
||||
If you downloaded LAMMPS from the public SVN or Git repositories, then
|
||||
If you downloaded LAMMPS from the public git repository, then
|
||||
the HTML and PDF files are not included. Instead you need to create
|
||||
them, in one of two ways:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue