Skip to content

Commit b76d19e

Browse files
committed
runtime/libia2: Update comments
1 parent c4656f9 commit b76d19e

File tree

1 file changed

+5
-4
lines changed
  • runtime/libia2/include

1 file changed

+5
-4
lines changed

runtime/libia2/include/ia2.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,11 +201,12 @@ size_t ia2_get_tag();
201201
/// Returns the current compartment number
202202
size_t ia2_get_compartment();
203203

204-
/// Registers the DSOs associated with a given protected compartment for use in ia2_main.
204+
/// Registers the DSOs associated with a given protected compartment. For use in ia2_main.
205205
///
206-
/// `lib` must be a DSO or "main" for the main executable.`extra_libraries` must be a
207-
/// semicolon-separated list of libraries. The pointers must remain valid after ia2_main returns.
208-
/// This function should not be called for compartment 0 since it is not a protected compartment.
206+
/// `lib` must be the filename of a ` DSO or "main" for the main executable.`extra_libraries` must
207+
/// be a semicolon-separated list of libraries or NULL. The pointers must remain valid after
208+
/// ia2_main returns. This function should not be called for compartment 0 since it is not a
209+
/// protected compartment.
209210
void ia2_register_compartment(const char *lib, int compartment, const char *extra_libraries);
210211

211212
/// The prototype for the user-defined config function which will be called before main.

0 commit comments

Comments
 (0)