From 80c82b8bbd599eabe8023ac81d71861367eeaad2 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Mon, 16 Mar 2015 09:15:24 +0100 Subject: [PATCH 1/3] include list of EasyBuild repositories cloned by install-EasyBuild-develop.sh script --- docs/Changelog.rst | 4 ++++ docs/Installation_Alternative.rst | 12 +++++++++++- docs/conf.py | 2 +- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/Changelog.rst b/docs/Changelog.rst index 8ae859bb..5a3d5429 100644 --- a/docs/Changelog.rst +++ b/docs/Changelog.rst @@ -3,6 +3,10 @@ Changelog for EasyBuild documentation ------------------------------------- +* **release 20150316.01** (`Mar 16th 2015`): + + * include list of EasyBuild repositories cloned by ``install-EasyBuild-develop.sh`` script + (see :ref:`install_latest_develop_using_script`) * **release 20150312.01** (`Mar 12th 2015`): * enhance documentation w.r.t. template values in configuration files (see :ref:`configuration_file_templates_constants`) diff --git a/docs/Installation_Alternative.rst b/docs/Installation_Alternative.rst index 8c72259c..98091326 100644 --- a/docs/Installation_Alternative.rst +++ b/docs/Installation_Alternative.rst @@ -174,8 +174,18 @@ Installation of latest development version using provided script ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ After you have forked each of the EasyBuild repositories on GitHub (+ vsc-base), you can set up a development version -of EasyBuild, in the following manner:: +of EasyBuild using the ``install-EasyBuild-develop.sh`` script. +This script will clone the different EasyBuild repositories from GitHub: + + * ``easybuild``: EasyBuild metapackage & documentation sources for http://easybuild.readthedocs.org + * ``vsc-base``: dependency for EasyBuild framework (logging, command line interface, ...) + * ``easybuild-framework``: EasyBuild framework + * ``easybuild-easyblocks``: collection of easyblocks + * ``easybuild-easyconfigs``: collection of easyconfig files + * ``easybuild-wiki``: EasyBuild wiki pages + +It can be used as follows:: # pick an installation prefix (adjust as you like) INSTALL_PREFIX=$(mktemp -d $HOME/EasyBuild-XXXXXX) # download script diff --git a/docs/conf.py b/docs/conf.py index 8305f97a..d6adf8b9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,7 +43,7 @@ # The short X.Y version. version = '2.0.0' # this is meant to reference the version of EasyBuild # The full version, including alpha/beta/rc tags. -release = '20150312.01' # this is meant to reference the version of the documentation itself +release = '20150316.01' # this is meant to reference the version of the documentation itself # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: From 1feba71ee497609a0c6f95891017360ed8dd4c81 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Mon, 16 Mar 2015 18:31:10 +0100 Subject: [PATCH 2/3] link to different EB repos --- docs/Installation_Alternative.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/Installation_Alternative.rst b/docs/Installation_Alternative.rst index 98091326..a7c63233 100644 --- a/docs/Installation_Alternative.rst +++ b/docs/Installation_Alternative.rst @@ -178,12 +178,18 @@ of EasyBuild using the ``install-EasyBuild-develop.sh`` script. This script will clone the different EasyBuild repositories from GitHub: - * ``easybuild``: EasyBuild metapackage & documentation sources for http://easybuild.readthedocs.org - * ``vsc-base``: dependency for EasyBuild framework (logging, command line interface, ...) - * ``easybuild-framework``: EasyBuild framework - * ``easybuild-easyblocks``: collection of easyblocks - * ``easybuild-easyconfigs``: collection of easyconfig files - * ``easybuild-wiki``: EasyBuild wiki pages + * `easybuild `_: + EasyBuild metapackage & documentation sources for http://easybuild.readthedocs.org + * `vsc-base `_: + dependency for EasyBuild framework (logging, command line interface, ...) + * `easybuild-framework `_: + EasyBuild framework + * `easybuild-easyblocks `_: + collection of easyblocks + * `easybuild-easyconfigs `_: + collection of easyconfig files + * `easybuild-wiki `_: + EasyBuild wiki pages It can be used as follows:: # pick an installation prefix (adjust as you like) From 4517155e5d9aa935d608dff5a236e7f41e571467 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Tue, 17 Mar 2015 10:35:56 +0100 Subject: [PATCH 3/3] fix formatting issue --- docs/Installation_Alternative.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Installation_Alternative.rst b/docs/Installation_Alternative.rst index a7c63233..897ccbd0 100644 --- a/docs/Installation_Alternative.rst +++ b/docs/Installation_Alternative.rst @@ -192,6 +192,7 @@ This script will clone the different EasyBuild repositories from GitHub: EasyBuild wiki pages It can be used as follows:: + # pick an installation prefix (adjust as you like) INSTALL_PREFIX=$(mktemp -d $HOME/EasyBuild-XXXXXX) # download script