Skip to content

docs: fix libkrun.h self-containment and net API refs #702

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.

Sign up for GitHub

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

Open
immanuwell wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix libkrun.h self-containment and net API refs #702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/images/libkrun_logo_horizontal_darkmode.png">
<source media="(prefers-color-scheme: light)" srcset="docs/images/libkrun_logo_horizontal.png">
<img alt="libkrun logo" src="docs/images/libkrun_logo_horizontal_200.png">
<img alt="libkrun logo" src="docs/images/libkrun_logo_horizontal.png">
</picture>

# libkrun
Expand Down Expand Up @@ -80,7 +80,7 @@ A conventional virtual interface that allows the guest to communicate with the o

#### Enabling virtio-net

Use `krun_add_net_unixstream` and/or `krun_add_net_unixdgram` to add a virtio-net interface connected to the userspace network proxy.
Use `krun_add_net_unixstream` and/or `krun_add_net_unixgram` to add a virtio-net interface connected to the userspace network proxy.

## Security model

Expand Down Expand Up @@ -216,7 +216,7 @@ This is a simple example providing ```chroot```-like functionality using ```libk

#### Building chroot_vm

To be able to ```chroot_vm```, you need need to build libkrun with the `virtio-block` and `virtio-net` optional features:
To be able to ```chroot_vm```, you need to build libkrun with the `virtio-block` and `virtio-net` optional features:

```
make BLK=1 NET=1
Expand Down
11 changes: 6 additions & 5 deletions include/libkrun.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ extern "C" {
#include <inttypes.h>
#include <stddef.h>
#include <stdbool.h>
#include <sys/types.h>
#include <unistd.h>

/**
Expand Down Expand Up @@ -391,10 +392,10 @@ int32_t krun_add_virtiofs3(uint32_t ctx_id,
* Arguments:
* "ctx_id" - the configuration context ID.
* "c_path" - a null-terminated string representing the path
* for the unixstream socket where the userspace
* for the Unix domain stream socket where the userspace
* network proxy is listening. Must be NULL if "fd"
* is not -1.
* "fd" - a file descriptor for an already open unixstream
* "fd" - a file descriptor for an already open Unix domain stream
* connection to the userspace network proxy. Must
* be -1 if "c_path" is not NULL.
* "c_mac" - MAC address as an array of 6 uint8_t entries.
Expand Down Expand Up @@ -433,10 +434,10 @@ int32_t krun_add_net_unixstream(uint32_t ctx_id,
* Arguments:
* "ctx_id" - the configuration context ID.
* "c_path" - a null-terminated string representing the path
* for the unixstream socket where the userspace
* for the Unix domain datagram socket where the userspace
* network proxy is listening. Must be NULL if "fd"
* is not -1.
* "fd" - a file descriptor for an already open unixstream
* "fd" - a file descriptor for an already open Unix domain datagram
* connection to the userspace network proxy. Must
* be -1 if "c_path" is not NULL.
* "c_mac" - MAC address as an array of 6 uint8_t entries.
Expand Down Expand Up @@ -520,7 +521,7 @@ int32_t krun_set_passt_fd(uint32_t ctx_id, int fd);
* Arguments:
* "ctx_id" - the configuration context ID.
* "c_path" - a null-terminated string representing the path for
* gvproxy's listen-vfkit unixdgram socket.
* gvproxy's listen-vfkit Unix domain datagram socket.
*
* Notes:
* If you never call this function, networking uses the TSI backend.
Expand Down