From 9c09babd299c9b6996d49a2ecfc63647a12e528c Mon Sep 17 00:00:00 2001 From: Tom Wallis Date: Tue, 7 Nov 2023 18:22:08 +0000 Subject: [PATCH] README.md hard-wrapped at 80 chars From [review feedback from Laurie](https://github.com/capablevms/cheri-examples/pull/88#discussion_r1383663278); thanks! --- example_allocators/compartment_alloc/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/example_allocators/compartment_alloc/README.md b/example_allocators/compartment_alloc/README.md index 505c942..adf971c 100644 --- a/example_allocators/compartment_alloc/README.md +++ b/example_allocators/compartment_alloc/README.md @@ -1,17 +1,17 @@ # Compartmentalising Allocator -A modification of the "bump allocator" in this repo. -This allocator creates compartments on the heap, and returns capabilities -to allocations within the compartment. +A modification of the "bump allocator" in this repo. This allocator creates +compartments on the heap, and returns capabilities to allocations within the +compartment. Because allocations are made against a compartment's (previously `mmap`'d) buffer, we need to identify the compartment being used when we call `malloc`. -`init_compartment` returns a capability used to identify the compartment it +`init_compartment` returns a capability used to identify the compartment it creates; calls to `malloc_compartment` accept this identifier as a parameter. `main.c` shows a simple use, with allocations against two different compartments. -Example is run using `make` in the typical fashion for the repo -(i.e. along the lines of `make -f Makefile.morello-hybrid run-main`). +Example is run using `make` in the typical fashion for the repo (i.e. along the +lines of `make -f Makefile.morello-hybrid run-main`).