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

Update architectures documentation #4336

Closed
mr-cal opened this issue Aug 28, 2023 · 3 comments · Fixed by #4349
Closed

Update architectures documentation #4336

mr-cal opened this issue Aug 28, 2023 · 3 comments · Fixed by #4349
Assignees
Labels
enhancement New features or optimizations

Comments

@mr-cal
Copy link
Collaborator

mr-cal commented Aug 28, 2023

What needs to get done

The architectures documentation needs to be improved, including:

  • default behaviors (e.g. core22 builds for all architectures)
  • description of architectural envvars
  • description of cli options (--target-arch, --build-for)
  • what happens in destructive mode (e.g. does the environment get cleaned?)
  • validation rules and limitations

I would like to get ideas and feedback from @rpjday.

Why it needs to get done

Architectures are complex and need thorough documentation.

@mr-cal mr-cal added the enhancement New features or optimizations label Aug 28, 2023
@rpjday
Copy link
Contributor

rpjday commented Aug 30, 2023

Working on it ...

@rpjday
Copy link
Contributor

rpjday commented Aug 30, 2023

First thing I would do is confirm the full set of valid architectures; also, is there any command that lists them? The way "snapcraft plugins" lists plugins, etc? Is there any command that produces that list?

Also, regarding those new, improved ARCH-related variables, what is the ETA on those dropping? Trying to figure out what I should say about them in the upcoming SC101 course.

@cmatsuoka
Copy link
Contributor

Consider adding a note to example 5 clarifying that Snapcraft won't cross-compile automatically, or maybe avoid using the term "cross-compilation" altogether.

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

Successfully merging a pull request may close this issue.

3 participants