1.1 --- a/README.txt Sat Sep 17 00:03:45 2022 +0200
1.2 +++ b/README.txt Tue Sep 20 01:04:19 2022 +0200
1.3 @@ -122,8 +122,11 @@
1.4 make -j8 O=mybuild
1.5
1.6 Along with the usual L4Re software, this will also build the software provided
1.7 -by this distribution if it has been copied into the pkg/departure location
1.8 -within the l4 directory.
1.9 +by this distribution if this distribution has been placed at the pkg/departure
1.10 +location within the l4 directory.
1.11 +
1.12 +Note also that to build this distribution successfully, the idl4re
1.13 +distribution must reside within the l4 directory, as noted above.
1.14
1.15 Defining the L4Re Configuration
1.16 ===============================
1.17 @@ -151,18 +154,18 @@
1.18 =========================
1.19
1.20 The program module lists in the conf subdirectory can either be appended to
1.21 -the L4Re conf/modules.list file, or a specific .list file can be copied to the
1.22 +the L4Re conf/modules.list file, or specific .list files can be copied to the
1.23 conf/modules.list location (potentially after taking a backup copy of the
1.24 original file). For example, from within the l4 directory:
1.25
1.26 cp conf/modules.list conf/modules.list.orig
1.27 -cp pkg/departure/conf/dstest_test.list conf/modules.list
1.28 +cat pkg/departure/conf/*.list > conf/modules.list
1.29
1.30 Running Programs from this Distribution
1.31 =======================================
1.32
1.33 With configuration measures in place, a program can be run in QEMU as follows:
1.34
1.35 -make O=mybuild qemu E=dstest_test
1.36 +make O=mybuild qemu E=dstest_test_client
1.37
1.38 The particular program used above is a short concurrency test.
2.1 --- a/docs/wiki/Client_Library Sat Sep 17 00:03:45 2022 +0200
2.2 +++ b/docs/wiki/Client_Library Tue Sep 20 01:04:19 2022 +0200
2.3 @@ -7,6 +7,9 @@
2.4 library, with the functions in the C library invoking client library functions
2.5 and employing client library structures internally.
2.6
2.7 +The client library is provided by `libfsclient` within the `departure`
2.8 +package.
2.9 +
2.10 <<TableOfContents(2,3)>>
2.11
2.12 == Header Files ==
3.1 --- a/docs/wiki/Components Sat Sep 17 00:03:45 2022 +0200
3.2 +++ b/docs/wiki/Components Tue Sep 20 01:04:19 2022 +0200
3.3 @@ -6,6 +6,9 @@
3.4 mechanisms for opening, reading, writing, and closing files, together with
3.5 various other operations.
3.6
3.7 +Components are provided by functionality in `libfsserver` used by programs
3.8 +found in the `servers` directory within the `departure` package.
3.9 +
3.10 <<TableOfContents(2,3)>>
3.11
3.12 Components are accessed via interfaces defined using the interface description
3.13 @@ -164,9 +167,10 @@
3.14 The operation yields a file opener appropriate for the given [[Users|user]]
3.15 credentials.
3.16
3.17 +((Openers))
3.18 == File and Directory Openers ==
3.19
3.20 -openers implement the `Opener` interface which provides the `context`
3.21 +Openers implement the `Opener` interface which provides the `context`
3.22 operation:
3.23
3.24 {{{
4.1 --- a/docs/wiki/Departure Sat Sep 17 00:03:45 2022 +0200
4.2 +++ b/docs/wiki/Departure Tue Sep 20 01:04:19 2022 +0200
4.3 @@ -74,3 +74,7 @@
4.4 Other concepts:
4.5
4.6 * [[Users]]
4.7 +
4.8 +Project organisation:
4.9 +
4.10 + * [[Libraries]]
5.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
5.2 +++ b/docs/wiki/Libraries Tue Sep 20 01:04:19 2022 +0200
5.3 @@ -0,0 +1,54 @@
5.4 += Libraries =
5.5 +
5.6 +Within the `departure` package, a number of libraries have been established to
5.7 +retain certain kinds of functionality. This document provides an overview of
5.8 +each of them.
5.9 +
5.10 +<<TableOfContents(2, 2)>>
5.11 +
5.12 +== libe2access ==
5.13 +
5.14 +Convenience functions for `libext2fs` operations.
5.15 +
5.16 +== libe2access_blockserver ==
5.17 +
5.18 +A convenience wrapper around `libext2fs`, providing initialisation functions
5.19 +for the opening of filesystems and for indicating the capability through which
5.20 +a block server, this providing a filesystem, may be accessed.
5.21 +
5.22 +== libexec ==
5.23 +
5.24 +Support for initialising and executing programs in new tasks.
5.25 +
5.26 +== libext2fs ==
5.27 +
5.28 +The ext2 filesystem library provided by the
5.29 +[[http://e2fsprogs.sourceforge.net/|e2fsprogs]] project.
5.30 +
5.31 +== libext2fs_blockserver ==
5.32 +
5.33 +Interfacing functions for `libext2fs`, permitting the library to access block
5.34 +servers, these being servers supporting the [[Components#Openers|opener]]
5.35 +interface, doing so using the [[Client Library|client library]].
5.36 +
5.37 +== libfsclient ==
5.38 +
5.39 +The [[Client Library|client library]] for accessing filesystem servers.
5.40 +
5.41 +== libfsserver ==
5.42 +
5.43 +The [[Server Library|server library]] providing supporting abstractions and
5.44 +functionality for filesystem-related [[Components|components]].
5.45 +
5.46 +== libipc ==
5.47 +
5.48 +A library providing IPC (interprocess communication) mechanisms to support
5.49 +communication and interactions between components.
5.50 +
5.51 +== libmem ==
5.52 +
5.53 +A library providing memory-related abstractions and utilities.
5.54 +
5.55 +== libsystypes ==
5.56 +
5.57 +A repository of fundamental types used by the other libraries.
6.1 --- a/docs/wiki/Server_Library Sat Sep 17 00:03:45 2022 +0200
6.2 +++ b/docs/wiki/Server_Library Tue Sep 20 01:04:19 2022 +0200
6.3 @@ -3,6 +3,9 @@
6.4 Within the filesystem server library, a number of different abstractions and
6.5 mechanisms are employed to provide access to filesystem objects.
6.6
6.7 +The server library is provided by `libfsserver` within the `departure`
6.8 +package.
6.9 +
6.10 <<TableOfContents(2,3)>>
6.11
6.12 This document uses C-style interface syntax since the components operating