Skip to content

Commit f73c74d

Browse files
committed
Improve docs
Signed-off-by: Doru Blânzeanu <[email protected]>
1 parent 94512d8 commit f73c74d

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,11 @@ For examples of guest applications, see the [./src/tests/c_guests](./src/tests/c
153153
- [src/hyperlight_common](./src/hyperlight_common)
154154

155155
- Test Guest Applications:
156-
- [src/tests/rust_guests](./src/tests/rust_guests) - This directory contains two Hyperlight Guest programs written in Rust, which are intended to be launched within partitions as "guests".
156+
- [src/tests/rust_guests](./src/tests/rust_guests) - This directory contains three Hyperlight Guest programs written in Rust, which are intended to be launched within partitions as "guests".
157157
- [src/tests/c_guests](./src/tests/c_guests) - This directory contains two Hyperlight Guest programs written in C, which are intended to be launched within partitions as "guests".
158158

159159
- Tests:
160-
- [src/hyperlight-testing](./src/hyperlight_testing) - Shared testing code for Hyperlight projects build int Rust.
160+
- [src/hyperlight-testing](./src/hyperlight_testing) - Shared testing code for Hyperlight projects built in Rust.
161161

162162
## Try it yourself!
163163

@@ -214,7 +214,7 @@ just rg # build the rust test guest binaries
214214
cargo run --example hello-world
215215
```
216216

217-
If all worked as expected, you should the following message in your console:
217+
If all worked as expected, you should see the following message in your console:
218218

219219
```text
220220
Hello, World! I am executing inside of a VM :)

docs/how-to-use-flatbuffers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# How to use FlatBuffers
22

3-
Flatbuffers is used to serialise and deserialize some data structures.
3+
Flatbuffers is used to serialize and deserialize some data structures.
44

5-
Schema files are used to define the data structures and are used to generate the code to serialise and deserialize the data structures.
5+
Schema files are used to define the data structures and are used to generate the code to serialize and deserialize the data structures.
66

77
Those files are located in the [`schema`](../src/schema) directory.
88

docs/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Hyperlight assumes that guest binaries are untrusted, and are running arbitrary,
88

99
### Hypervisor Isolation
1010

11-
Hyperlight runs all guest code inside a Virtual Machine, Each VM only has access to a very specific, small (by default) pre-allocted memory buffer in the host's process, no dynamic memory alocations are allowed. As a result, any attempt by the guest to read or write to memory anywhere outside of that particular buffer is caught by the hypervisor. Similarly, the guest VM does not have any access to devices since non are provided by the hyperlight host library, therefore there is no file, network, etc. access available to guest code.
11+
Hyperlight runs all guest code inside a Virtual Machine, Each VM only has access to a very specific, small (by default) pre-allocated memory buffer in the host's process, no dynamic memory allocations are allowed. As a result, any attempt by the guest to read or write to memory anywhere outside of that particular buffer is caught by the hypervisor. Similarly, the guest VM does not have any access to devices since non are provided by the hyperlight host library, therefore there is no file, network, etc. access available to guest code.
1212

1313
### Host-Guest Communication (Serialization and Deserialization)
1414

0 commit comments

Comments
 (0)