Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: instructions to update an existing install #212

Merged
merged 1 commit into from Apr 29, 2016
Merged

DOC: instructions to update an existing install #212

merged 1 commit into from Apr 29, 2016

Conversation

andreas-h
Copy link
Contributor

following an e-mail from @boegel

boegel
boegel reviewed Apr 19, 2016
View reviewed changes
docs/Installation.rst

To upgrade to a newer EasyBuild version (say, *x.y.z*) than the one currently installed (say, *a.b.c*), there are several options:

(i) (re)bootstrap EasyBuild to obtain an EasyBuild/x.y.z module to load, using the instructions above, see :ref:`bootstrapping`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andreas-h please use backticks for make the module name 'jump out', i.e.:

`EasyBuild/x.y.z`

@andreas-h
Copy link
Contributor Author

Mhh, @boegel, if I use backticks for

`EasyBuild/x.y.z`

I'd rather not use the |version| substitution, because then the user would see the result of |version| in some places, and x.y.z in the module name (or is it possible to somehow use a substitution within the backticks? I couldn't figure out how), which would be confusing. Do you agree?

@boegel
Copy link
Member

boegel commented Apr 19, 2016

@andreas-h Yes, you're right, but then I would opt for using EasyBuild/|version|, where |version| should still get replace properly.

Showing how to upgrade to the latest version makes sense, while using x.y.z may make things less clear; people tend to only half read documentation, and look for patterns instead :)

@boegel boegel mentioned this pull request Apr 29, 2016
Merged
@boegel boegel merged commit 349832d into easybuilders:develop Apr 29, 2016
@boegel
Copy link
Member

boegel commented Apr 29, 2016

merged via #215, thanks @andreas-h!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@andreas-h @boegel