Expanded the basic-porting.mdx file so it includes a tutorial on porting external libraries#552
Conversation
There was a problem hiding this comment.
Pull request overview
This PR expands the existing “basic porting” guide to cover porting external C libraries alongside a simple application example, incorporating lessons from earlier Unikraft sessions.
Changes:
- Updates the guide title/description to include library porting.
- Reflows and extends the existing
echo/pwdporting tutorial text. - Adds a new section describing external library porting concepts plus a kdtree practical exercise.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
razvand
left a comment
razvand
left a comment
There was a problem hiding this comment.
See the linter checks. In particular, use a single sentence on a line.
Do not add the library porting in the basic-porting.mdx guide. Create a new guide called library-porting.mdx. We will end up with three porting guides: basic-porting.mdx, library-porting.mdx and advanced-porting.mdx.
Add a commit body to your commit.
Prefix the commit title with feat(guides):.
StefanAMN
force-pushed
the
stancustefan/expand-basic-porting.mdx
branch
from
745bedd to
15d82d6
Compare
StefanAMN
force-pushed
the
stancustefan/expand-basic-porting.mdx
branch
2 times, most recently
from
c16d1a1 to
9b75f82
Compare
razvand
left a comment
razvand
left a comment
There was a problem hiding this comment.
Wrap commit description lines to 72 lines.
StefanAMN
force-pushed
the
stancustefan/expand-basic-porting.mdx
branch
from
9b75f82 to
d9e1eda
Compare
razvand
left a comment
razvand
left a comment
There was a problem hiding this comment.
Use Add instead of add at the start of the commit title: feat(guides): add ... should be feat(guides): Add ....
Introduce a new guide in `library-porting.mdx` explaining the process of porting external libraries to Unikraft. Additionally, reformat `basic-porting.mdx` and `library-porting.mdx` to adhere to the linter's requirement of a single sentence per line. Signed-off-by: Stefan Stancu <stefanstancu2006@gmail.com>
StefanAMN
force-pushed
the
stancustefan/expand-basic-porting.mdx
branch
from
d9e1eda to
0a199c7
Compare
I added a new part in the basic-porting.mdx file that includes a small guide on importing external libraries, which comes mainly from the hackathons/sessions/contributing-to-unikraft folder in an old commit, couples with some other ideas from some sessions from USoC23. This expands on the basic-porting.mdx file and integrates lessons from USoC23 regarding external C library porting.