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 build instruction on AlpineLinux #258

Merged
merged 1 commit into from
Dec 2, 2023

Conversation

seia-soto
Copy link
Contributor

This PR adds Incus build instruction on AlpineLinux.

Motivation

AlpineLinux is lightweight Linux distro suitable for containers and virtualization even as host operating system.
Add build and running instruction of Incus on AlpineLinux, so Incus can be used by wider users.

See the forum reference link above for my personal use-case of AlpineLinux and Incus.

Possible considerations on PR

Heading prefix of instruction on other Linux distros

I used Other distros: [distro name here] in the commit but I'd like to accept suggestion for better prefix. The final ToC will look like:

Install Incus from source
From source: Build the latest version
From source: Build a release
Start the build
From source: Install
Machine setup
+ Other distros: AlpineLinux
+ > make: gettext.cgo2.c:(.text+0x2b9): undefined reference to `libintl_gettext’

Emphasis as header

The commit includes 4th heading to describe why specific commands is used to resolve build time issues. If you think it's going to mess up the ToC, consider to allow the rule MD036 or replace with list.

% make doc-lint | grep -i installing.md
.tmp/doc/installing.md:273: MD036 Emphasis used instead of a header

Currently lint result on installing.md has no problem.

  • Current
#### `make`: gettext.cgo2.c:(.text+0x2b9): undefined reference to `libintl_gettext'
  • Allowing the rule MD036
**`make`: gettext.cgo2.c:(.text+0x2b9): undefined reference to `libintl_gettext'**
  • Using list
- `make`: gettext.cgo2.c:(.text+0x2b9): undefined reference to `libintl_gettext'

Future considerations

@github-actions github-actions bot added the Documentation Documentation needs updating label Dec 1, 2023
@seia-soto
Copy link
Contributor Author

Added sign off message in the commit as CONTRIBUTING.md describes.

Signed-off-by: HoJeong Go <seia@outlook.kr>
@stgraber stgraber merged commit c312501 into lxc:main Dec 2, 2023
25 checks passed
@stgraber
Copy link
Member

stgraber commented Dec 2, 2023

Thanks!

I'll send a follow-up PR which does some re-organization on that page to make it less Ubuntu/Debian specific overall and make it easier to get the instructions for whatever distribution you're running.

@seia-soto
Copy link
Contributor Author

seia-soto commented Dec 2, 2023

Thanks for your effort!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Development

Successfully merging this pull request may close these issues.

2 participants