diff options
| author | Alec Scott <hi@alecbcs.com> | 2024-09-27 09:09:19 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-27 09:09:19 -0700 |
| commit | 9b5f15abecaf9a30a2fece62e60097ce78fc9c10 (patch) | |
| tree | 266e690c894d1c8a4f6f6d18968b10e139092f1d /lib | |
| parent | 9ad1d0c813aa7fc8a979f271853ab865b6cda19d (diff) | |
| download | spack-9b5f15abecaf9a30a2fece62e60097ce78fc9c10.tar.gz spack-9b5f15abecaf9a30a2fece62e60097ce78fc9c10.tar.bz2 spack-9b5f15abecaf9a30a2fece62e60097ce78fc9c10.tar.xz spack-9b5f15abecaf9a30a2fece62e60097ce78fc9c10.zip | |
docs: add --depth=2 to reduce download size (#46605)
* docs: add --depth=2 to reduce download size
* Add note to tell users about --depth=2 and manyFiles
* Fix inline code in info block
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/spack/docs/getting_started.rst | 8 | ||||
| -rw-r--r-- | lib/spack/docs/index.rst | 7 |
2 files changed, 12 insertions, 3 deletions
diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst index 7bcb7b178d..cb8a586e3c 100644 --- a/lib/spack/docs/getting_started.rst +++ b/lib/spack/docs/getting_started.rst @@ -61,10 +61,15 @@ Getting Spack is easy. You can clone it from the `github repository .. code-block:: console - $ git clone -c feature.manyFiles=true https://github.com/spack/spack.git + $ git clone -c feature.manyFiles=true --depth=2 https://github.com/spack/spack.git This will create a directory called ``spack``. +.. note:: + ``-c feature.manyFiles=true`` improves git's performance on repositories with 1,000+ files. + + ``--depth=2`` prunes the git history to reduce the size of the Spack installation. + .. _shell-support: ^^^^^^^^^^^^^ @@ -1576,4 +1581,3 @@ The intent is to provide a Windows installer that will automatically set up Python, Git, and Spack, instead of requiring the user to do so manually. Instructions for creating the installer are at https://github.com/spack/spack/blob/develop/lib/spack/spack/cmd/installer/README.md - diff --git a/lib/spack/docs/index.rst b/lib/spack/docs/index.rst index 410cb8e41c..e2c7219e7b 100644 --- a/lib/spack/docs/index.rst +++ b/lib/spack/docs/index.rst @@ -39,10 +39,15 @@ package: .. code-block:: console - $ git clone -c feature.manyFiles=true https://github.com/spack/spack.git + $ git clone -c feature.manyFiles=true --depth=2 https://github.com/spack/spack.git $ cd spack/bin $ ./spack install libelf +.. note:: + ``-c feature.manyFiles=true`` improves git's performance on repositories with 1,000+ files. + + ``--depth=2`` prunes the git history to reduce the size of the Spack installation. + If you're new to spack and want to start using it, see :doc:`getting_started`, or refer to the full manual below. |