# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1670796245 -3600
# Node ID 3bfe96e5fc6e4ab1456fb31100b8033837855bbd
# Parent  63a4bdbf1bc239c86a7c45446602711c8723a6b7
Made some small documentation improvements.

diff -r 63a4bdbf1bc2 -r 3bfe96e5fc6e README.txt
--- a/README.txt	Sun Dec 11 19:03:40 2022 +0100
+++ b/README.txt	Sun Dec 11 23:04:05 2022 +0100
@@ -7,6 +7,30 @@
 This directory (departure) should be installed within the pkg directory in the
 L4Re distribution.
 
+More information can be found in the docs directory in this distribution.
+
+ * For reading in a text editor, see docs/wiki/Departure
+ * For reading in a Web browser, see docs/html/index.html
+
+A Note about the Documentation
+------------------------------
+
+The original content in docs/wiki aims to be readable as plain text under most
+circumstances, but the intention is that this content be translated to HTML
+since it employs a formatting language based on the MoinMoin wiki format
+syntax.
+
+The following command can be used to generate the HTML form of the
+documentation from the main directory of this distribution:
+
+./docs/tools/make_docs.sh
+
+Specify the --web option for Web server deployment:
+
+./docs/tools/make_docs.sh --web
+
+To generate individual documents, specify their names after any options.
+
 Prerequisites
 =============
 
@@ -31,7 +55,7 @@
 When building the Departure software within the L4Re build system, the idl4re
 directory will need to be present in the appropriate location, this being
 inside the l4 directory. The easiest way of satisfying this requirement is to
-copy the idl4re directory into the l4 directory and making sure that the
+copy or move the idl4re directory into the l4 directory, making sure that the
 software is built before trying to build L4Re itself.
 
 Obtaining and Building Fiasco.OC and L4Re
@@ -94,7 +118,17 @@
 
 To build this distribution successfully along with the rest of the L4Re
 sources, the idl4re distribution must reside within the l4 directory and the
-software built, as described above.
+idl tool built, as described above, and this distribution must be placed at
+the pkg/departure location within the l4 directory.
+
+To summarise:
+
+l4/
+  idl4re/
+    idl - the built idl tool
+  pkg/
+    departure/
+      README.txt - this file
 
 Here is a quick summary of the build process for L4Re, also starting at the
 parent directory of the Fiasco.OC and L4Re distributions:
@@ -109,8 +143,7 @@
 make -j8 O=mybuild
 
 Along with the usual L4Re software, this will also build the software provided
-by this distribution if this distribution has been placed at the pkg/departure
-location within the l4 directory.
+by this distribution if the above instructions have been followed.
 
 Defining the L4Re Configuration
 ===============================
@@ -153,3 +186,17 @@
 make O=mybuild qemu E=dstest_test_client
 
 The particular program used above is a short concurrency test.
+
+Copyright and Licence Information
+=================================
+
+See the following Web pages for more information about this work:
+
+https://projects.boddie.org.uk/Departure
+
+The author can be contacted at the following e-mail address:
+
+paul@boddie.org.uk
+
+Copyright and licence information can be found in the docs directory - see
+docs/COPYING.txt and docs/LICENCE.txt for more information.
diff -r 63a4bdbf1bc2 -r 3bfe96e5fc6e docs/wiki/Components
--- a/docs/wiki/Components	Sun Dec 11 19:03:40 2022 +0100
+++ b/docs/wiki/Components	Sun Dec 11 23:04:05 2022 +0100
@@ -8,7 +8,7 @@
 
 Components are provided by functionality in [[Libraries#libfsserver|
 `libfsserver`]] used by programs found in the `servers` directory within the
-`departure` package.
+`departure` package. In general, each component runs in its own server thread.
 
 <<TableOfContents(2,3)>>
 
diff -r 63a4bdbf1bc2 -r 3bfe96e5fc6e docs/wiki/Filesystem_Access
--- a/docs/wiki/Filesystem_Access	Sun Dec 11 19:03:40 2022 +0100
+++ b/docs/wiki/Filesystem_Access	Sun Dec 11 23:04:05 2022 +0100
@@ -269,6 +269,12 @@
 
 ########
 
+The `Resource` obtained to deliver file content to a client will be served by
+a distinct thread through a dedicated communications endpoint, leaving the
+`Opener` available to satisfy other requests. This new thread will remain
+active while a file remains open, being terminated when the file is closed and
+the communications endpoint released by the client.
+
 == Notifications ==
 
 Within the filesystem access architecture, users of files may act in ways that