Skip to content

Update docs on "spack external find"#16482

Merged
tgamblin merged 5 commits intospack:developfrom
scheibelp:bugfix/improve-find-ext-docs
May 13, 2020
Merged

Update docs on "spack external find"#16482
tgamblin merged 5 commits intospack:developfrom
scheibelp:bugfix/improve-find-ext-docs

Conversation

@scheibelp
Copy link
Copy Markdown
Member

#15158 (review) mentioned several ways that the documentation for spack external find could be substantially improved:

  • Provide a code example of implementing determine_spec_details for a package
  • Explain how to define executables to look for (and also e.g. that they are treated as regular expressions and so can pull in unexpected files).
  • Add the "why" for a couple of constraints (i.e. explain that this logic only works for build/run deps because it examines PATH for executables)

@alalazo alalazo added the documentation Improvements or additions to documentation label May 6, 2020
@scheibelp scheibelp requested a review from tgamblin May 6, 2020 23:58
@scheibelp
Copy link
Copy Markdown
Member Author

Close/reopen to restart tests

@scheibelp scheibelp closed this May 7, 2020
@scheibelp scheibelp reopened this May 7, 2020
@scheibelp
Copy link
Copy Markdown
Member Author

Trying again

@scheibelp scheibelp closed this May 7, 2020
@scheibelp scheibelp reopened this May 7, 2020
Copy link
Copy Markdown
Member

@tgamblin tgamblin left a comment

Choose a reason for hiding this comment

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

A few remaining minor requests.

Copy link
Copy Markdown
Member

@tgamblin tgamblin left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks @scheibelp

@tgamblin tgamblin merged commit 701fc1f into spack:develop May 13, 2020
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