Skip to content

Commit

Permalink
s/cherimcu/cheriot/
Browse files Browse the repository at this point in the history
There was a note that these names predated the project name and would
change.  Now they have.

Fixes #2
  • Loading branch information
davidchisnall committed Feb 12, 2024
1 parent 8c5b5d4 commit 27bd10a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
2 changes: 1 addition & 1 deletion text/compartments.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ This is cross-referenced with a section like this:
"sealing_type": {
"compartment": "alloc",
"key": "MallocKey",
"provided_by": "build/cheriot/cheriot/release/cherimcu.allocator.compartment",
"provided_by": "build/cheriot/cheriot/release/cheriot.allocator.compartment",
"symbol": "__export.sealing_type.alloc.MallocKey"
}
},
Expand Down
11 changes: 4 additions & 7 deletions text/debugging_apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,25 +44,22 @@ You must also opt your compartment or library into debugging support by adding t
[,lua]
----
compartment("myComponent")
add_rules("cherimcu.component-debug")
add_rules("cheriot.component-debug")
----
By default, this assumes that the `debugOption` that you've provided has the same name as the target.
Sometimes, it's useful to have a single debug option that enables or disables debugging for multiple components.
You can set the `cherimcu.debug-name` target property in your component to the name that you expect, with a line like this:
You can set the `cheriot.debug-name` target property in your component to the name that you expect, with a line like this:
[,lua]
----
compartment("myComponent")
add_rules("cherimcu.component-debug")
add_rules("cheriot.component-debug")
on_load(function (target)
target:set('cherimcu.debug-name', "nameOfDebugOption")
target:set('cheriot.debug-name', "nameOfDebugOption")
end)
----
CAUTION: The use of cherimcu here is historical.
This will change to cheriot in a future version.
Now, your compartment will be compiled with a macro that starts with `DEBUG_` and ends with the name of the debug option in all capitals.
In the first example above, this would be `DEBUG_MYCOMPONENT`.

Expand Down

0 comments on commit 27bd10a

Please sign in to comment.