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

docs/usage: Add build and run complex apps doc #147

Merged
merged 1 commit into from
Apr 18, 2023

Conversation

mariasfiraiala
Copy link
Contributor

This PR adds documentation for building and running complex applications on x86 and AArch64.

It goes into detail regarding configuration steps and manual launch commands for the make build system.
Depends on having these PRs merged:

Signed-off-by: Maria Sfiraiala [email protected]

@mariasfiraiala mariasfiraiala changed the title docs/develop: Add build and run complex apps doc [DRAFT] docs/develop: Add build and run complex apps doc Oct 22, 2022
@StefanJum StefanJum linked an issue Oct 22, 2022 that may be closed by this pull request
@StefanJum StefanJum added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 22, 2022
@mariasfiraiala mariasfiraiala force-pushed the marias/docs-complex-apps branch 2 times, most recently from ff67f00 to 7ec2ce9 Compare March 2, 2023 08:35
@mariasfiraiala mariasfiraiala marked this pull request as ready for review March 2, 2023 08:37
@mariasfiraiala mariasfiraiala changed the title [DRAFT] docs/develop: Add build and run complex apps doc docs/usage: Add build and run complex apps doc Mar 2, 2023
@mariasfiraiala
Copy link
Contributor Author

With the transition to musl finally stable, I got the time to revisit this PR and finalize the documentation. @StefanJum @razvand please take a look when you have the time.

Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

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

Thanks a lot @mariasfiraiala, see my comments.

content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
@mariasfiraiala
Copy link
Contributor Author

Done @StefanJum! Take another tour when you find the time.

Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

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

Looks really nice @mariasfiraiala, thank you.
I will test the command in the next few days and come back with a new round.

content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
@mariasfiraiala
Copy link
Contributor Author

Great thing @StefanJum. I've also integrated your latest suggestions. Hope it looks alright now (Markdown wise).

Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

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

Great work @mariasfiraiala, I tested the commands and everything works well.
See the few comments I left.

content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Show resolved Hide resolved
@mariasfiraiala
Copy link
Contributor Author

I've committed your suggestions @StefanJum. Take another look!

Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

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

All good besides the few comments, thanks @mariasfiraiala.
@razvand please take a quick look over this.

content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

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

All good, thanks.

Reviewed-by: Stefan Jumarea [email protected]
Approved-by: Stefan Jumarea [email protected]

Copy link
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

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

Hi, @mariasfiraiala. This looks very good. See my minor comments.

I want to take another tour, to test the steps you mentioned and make sure everything is clear for future readers.

content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
@mariasfiraiala
Copy link
Contributor Author

Done @razvand. Take another look, please.

Copy link
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

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

Hi, @mariasfiraiala, see my comments. Also use virbr0 as the bridge ID, instead of kraft0, throughout the tutorial.

content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
content/en/docs/usage/make_build.md Show resolved Hide resolved
content/en/docs/usage/make_build.md Outdated Show resolved Hide resolved
This commit adds documentation for building and running complex
applications on `x86` and `AArch64`.

It goes into detail regarding configuration steps and manual launch
commands for the make build system.

Signed-off-by: Maria Sfiraiala <[email protected]>
@mariasfiraiala
Copy link
Contributor Author

Just integrated what you've suggested @razvand! Thanks for the time and take another look, please!

Copy link
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

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

Thanks, @mariasfiraiala.

Reviewed-by: Razvan Deaconescu [email protected]
Approved-by: Razvan Deaconescu [email protected]

@razvand razvand merged commit dbf7f77 into unikraft:main Apr 18, 2023
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 enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add complex apps build docs on different architectures
3 participants