L4Re/departure

Annotated docs/wiki/Libraries

427:440178360e6c
2022-09-20 Paul Boddie Updated the documentation to reflect naming changes, also adding library information.
paul@427 1
= Libraries =
paul@427 2
paul@427 3
Within the `departure` package, a number of libraries have been established to
paul@427 4
retain certain kinds of functionality. This document provides an overview of
paul@427 5
each of them.
paul@427 6
paul@427 7
<<TableOfContents(2, 2)>>
paul@427 8
paul@427 9
== libe2access ==
paul@427 10
paul@427 11
Convenience functions for `libext2fs` operations.
paul@427 12
paul@427 13
== libe2access_blockserver ==
paul@427 14
paul@427 15
A convenience wrapper around `libext2fs`, providing initialisation functions
paul@427 16
for the opening of filesystems and for indicating the capability through which
paul@427 17
a block server, this providing a filesystem, may be accessed.
paul@427 18
paul@427 19
== libexec ==
paul@427 20
paul@427 21
Support for initialising and executing programs in new tasks.
paul@427 22
paul@427 23
== libext2fs ==
paul@427 24
paul@427 25
The ext2 filesystem library provided by the
paul@427 26
[[http://e2fsprogs.sourceforge.net/|e2fsprogs]] project.
paul@427 27
paul@427 28
== libext2fs_blockserver ==
paul@427 29
paul@427 30
Interfacing functions for `libext2fs`, permitting the library to access block
paul@427 31
servers, these being servers supporting the [[Components#Openers|opener]]
paul@427 32
interface, doing so using the [[Client Library|client library]].
paul@427 33
paul@427 34
== libfsclient ==
paul@427 35
paul@427 36
The [[Client Library|client library]] for accessing filesystem servers.
paul@427 37
paul@427 38
== libfsserver ==
paul@427 39
paul@427 40
The [[Server Library|server library]] providing supporting abstractions and
paul@427 41
functionality for filesystem-related [[Components|components]].
paul@427 42
paul@427 43
== libipc ==
paul@427 44
paul@427 45
A library providing IPC (interprocess communication) mechanisms to support
paul@427 46
communication and interactions between components.
paul@427 47
paul@427 48
== libmem ==
paul@427 49
paul@427 50
A library providing memory-related abstractions and utilities.
paul@427 51
paul@427 52
== libsystypes ==
paul@427 53
paul@427 54
A repository of fundamental types used by the other libraries.