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.

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

DOC: Add documentation on CONDA_OVERRIDE_ARCHSPEC #14

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Dec 18, 2024

Resolves #13

(Does this by addressesing the request in #13 (comment))

Checklist

  • Used a personal fork of the feedstock to propose changes
  • Bumped the build number (if the version is unchanged)
    • This is documentation only, so there is no need to publish a new build to Anaconda's servers.
  • [N/A] Reset the build number to 0 (if the version changed)
  • Re-rendered with the latest conda-smithy (Use the phrase @conda-forge-admin, please rerender in a comment in this PR for automated rerendering)
  • Ensured the license file is being packaged.

* Add instructions for overriding the __archspec virtual package with the
  CONDA_OVERRIDE_ARCHSPEC environment variable.
   - c.f. https://docs.conda.io/projects/conda/en/stable/user-guide/tasks/manage-virtual.html
* Note that the _{{ family }}-microarch-level packages are not intended
  for users to ever interact with directly.
@matthewfeickert
Copy link
Member Author

@conda-forge-admin, please rerender

@conda-forge-admin
Copy link
Contributor

conda-forge-admin commented Dec 18, 2024

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipe/meta.yaml) and found some lint.

Here's what I've got...

For recipe/meta.yaml:

  • ❌ The recipe must have some tests.

This message was generated by GitHub Actions workflow run https://github.com/conda-forge/conda-forge-webservices/actions/runs/12402018273. Examine the logs at this URL for more detail.

@matthewfeickert matthewfeickert marked this pull request as ready for review December 18, 2024 21:59
@matthewfeickert
Copy link
Member Author

matthewfeickert commented Dec 18, 2024

@ikrommyd @jjerphan as you were also involved with this discussion I'd like to request reviews from you as well as @isuruf.

It is probably easiest to just read the rerendered text on my fork's PR branch: https://github.com/matthewfeickert/microarch-level-feedstock/tree/doc/add-instructions-on-override-of-level?tab=readme-ov-file#about-x86_64-microarch-level


I will open up a PR to https://github.com/conda-forge/conda-forge.github.io that addresses conda-forge/conda-forge.github.io#2105 once this PR has been reviewed and merged. I'll also read over conda-forge/conda-forge.github.io#1261.

@matthewfeickert
Copy link
Member Author

Given that I mentioned conda-forge/conda-forge.github.io#2105, cc @traversaro for feedback here too.

@traversaro
Copy link

Thanks! I think the documentation in this PR make sense.

@ikrommyd
Copy link

I'm happy with the README updates. I don't know if it deserves a mention here: https://docs.conda.io/projects/conda/en/stable/user-guide/tasks/manage-virtual.html as well

@traversaro
Copy link

I do not think we need to modify the docs, but I think it there is a related CEP PR that may be of interest to anyone contributing to this discussion: conda/ceps#103 .

In [rare circumstances](https://github.com/conda-forge/microarch-level-feedstock/issues/13#issuecomment-2551385113)
where a particular level needs to be forced, this can be achieved by
overriding the `__archspec`
[virtual package](https://docs.conda.io/projects/conda/en/stable/user-guide/tasks/manage-virtual.html)
Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know if it deserves a mention here: https://docs.conda.io/projects/conda/en/stable/user-guide/tasks/manage-virtual.html as well

@ikrommyd I already link that here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Specifying _x86_64-microarch-level=something doesn't solve properly.
4 participants