Skip to content

Installation: do not recommend to delete the .spack directory#216

Merged
marcpaterno merged 1 commit intoFramework-R-D:mainfrom
pcanal:installation
Dec 19, 2025
Merged

Installation: do not recommend to delete the .spack directory#216
marcpaterno merged 1 commit intoFramework-R-D:mainfrom
pcanal:installation

Conversation

@pcanal
Copy link
Contributor

@pcanal pcanal commented Dec 19, 2025

This avoid inadvertently removing user content.

@pcanal pcanal self-assigned this Dec 19, 2025
@pcanal pcanal added the documentation Improvements or additions to documentation label Dec 19, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR removes the potentially dangerous step that recommended deleting the ~/.spack directory from the installation instructions, helping to protect users from accidentally removing their own content or configurations.

  • Removed Step 2 which instructed users to run rm -rf $HOME/.spack
  • Renumbered subsequent installation steps from Step 3-8 to Step 2-7

```

Then make sure you don't already have a spack command on your PATH:
```bash
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

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

Line 25 has trailing whitespace after the word "spack". This violates the project's text formatting standards which require no trailing whitespace on any line.

Copilot generated this review using guidance from repository custom instructions.
```bash
source ${HOME}/spack/share/spack/setup-env.sh
```
`which spack` will show that `spack` is a bash function.
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

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

Line 41 has trailing whitespace after "function.". This violates the project's text formatting standards which require no trailing whitespace on any line.

Copilot generated this review using guidance from repository custom instructions.
```bash
git clone --depth=2 https://github.com/spack/spack.git
```
If you encounter trouble, consult the [installation instructions from the Spack project]( https://spack-tutorial.readthedocs.io/en/latest/tutorial_basics.html#basics-tutorial).
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

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

This line contains a bare URL that should be formatted as a proper Markdown link. The URL has an extra space after the opening bracket which creates an invalid Markdown link syntax. The space after the opening parenthesis in "( https" should be removed.

Suggested change
If you encounter trouble, consult the [installation instructions from the Spack project]( https://spack-tutorial.readthedocs.io/en/latest/tutorial_basics.html#basics-tutorial).
If you encounter trouble, consult the [installation instructions from the Spack project](https://spack-tutorial.readthedocs.io/en/latest/tutorial_basics.html#basics-tutorial).

Copilot uses AI. Check for mistakes.
@marcpaterno marcpaterno merged commit 9b9dc70 into Framework-R-D:main Dec 19, 2025
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants