summaryrefslogtreecommitdiff
path: root/hurd/interface
diff options
context:
space:
mode:
authorThomas Schwinge <schwinge@nic-nac-project.de>2009-08-18 15:51:49 +0200
committerThomas Schwinge <schwinge@nic-nac-project.de>2009-08-18 15:51:49 +0200
commit508d432bd5e43b2af315b1a8a99fdb84c4bd294a (patch)
treea32aa83a168fc0863cc12a582ad93136ac1f7cce /hurd/interface
parent1d0a8b4b251179c4f14876ad06e39d4ea0d5a496 (diff)
Some examples gathered from Hurd sources.
Diffstat (limited to 'hurd/interface')
-rw-r--r--hurd/interface/fs/13.mdwn22
-rw-r--r--hurd/interface/fs/14.mdwn29
-rw-r--r--hurd/interface/fsys/04.mdwn35
3 files changed, 86 insertions, 0 deletions
diff --git a/hurd/interface/fs/13.mdwn b/hurd/interface/fs/13.mdwn
index 72ae0d06..2e06e0c4 100644
--- a/hurd/interface/fs/13.mdwn
+++ b/hurd/interface/fs/13.mdwn
@@ -21,6 +21,28 @@ Sync the individual file. If `omit_metadata` is set, then it is only necessary
for the server to updated the actual contents of the file, not any associated
metadata.
+# Implementation Examples
+
+Servers that either don't keep any unsynchronized state (or don't have a
+backing store at all) can simply `return 0`. Examples: [[translator/nfs]].
+
+## [[libtrivfs]]
+
+Pass the call through to the underlying node.
+
+### [[storeio]] / [[streamio]]
+
+Instead of to the underlying node, pass the call through to the backend
+(device).
+
+## [[libnetfs]]
+
+Invoke `netfs_attempt_sync`.
+
+## [[libdiskfs]]
+
+Invoke `diskfs_file_update`.
+
# Usage Examples
## [[glibc]]
diff --git a/hurd/interface/fs/14.mdwn b/hurd/interface/fs/14.mdwn
index 85d8a73a..c93613d8 100644
--- a/hurd/interface/fs/14.mdwn
+++ b/hurd/interface/fs/14.mdwn
@@ -19,6 +19,35 @@ License|/fdl]]."]]"""]]
Sync the entire filesystem.
+# Implementation Examples
+
+Servers that either don't keep any unsynchronized state (or don't have a
+backing store at all) can simply `return 0`. Examples: [[translator/nfs]].
+
+The implementation typically doesn't care on which specific node (as exported
+by the implementing server) [[`file_syncfs`|file_syncfs]] is being invoked on.
+
+## [[libtrivfs]]
+
+Invoke [[`file_sync`|file_sync]] on the underlying node. Rationale: the
+underlying node represents this filesystem's backend, and once this node is
+synchronized, the whole [[libtrivfs]]-based filesystem is to be considered
+synchronized.
+
+### [[storeio]] / [[streamio]]
+
+Instead of the to underlying node, pass the call through to the backend
+(device).
+
+## [[libnetfs]]
+
+Invoke `netfs_attempt_syncfs`.
+
+## [[libdiskfs]]
+
+Invoke [[`fsys_syncfs`|fsys_syncfs]] on all active children, and invoke
+`diskfs_sync_everything` and `diskfs_set_hypermetadata`.
+
# Usage Examples
## [[glibc]]
diff --git a/hurd/interface/fsys/04.mdwn b/hurd/interface/fsys/04.mdwn
index 0ef242f9..60d314c5 100644
--- a/hurd/interface/fsys/04.mdwn
+++ b/hurd/interface/fsys/04.mdwn
@@ -18,3 +18,38 @@ License|/fdl]]."]]"""]]
Sync a filesystem. Args are the same as for [[`file_syncfs`|file_syncfs]] in
[[`fs.defs`|fs]].
+
+# Implementation Examples
+
+Servers that either don't keep any unsynchronized state (or don't have a
+backing store at all) can simply `return 0`. Examples: [[translator/symlink]],
+[[translator/nfs]].
+
+## [[libtrivfs]]
+
+Invoke [[`file_sync`|file_sync]] on the underlying node. Rationale: the
+underlying node represents this filesystem's backend, and once this node is
+synchronized, the whole [[libtrivfs]]-based filesystem is to be considered
+synchronized.
+
+### [[storeio]] / [[streamio]]
+
+Instead of to the underlying node, pass the call through to the backend
+(device).
+
+## [[libnetfs]]
+
+Invoke `netfs_attempt_syncfs`.
+
+## [[libdiskfs]]
+
+Invoke [[`fsys_syncfs`|fsys_syncfs]] on all active children, and invoke
+`diskfs_sync_everything` and `diskfs_set_hypermetadata`.
+
+# Usage Examples
+
+## [[libdiskfs]]
+
+In the implementations of both [[`file_syncfs`|file_syncfs]] and
+[[`fsys_syncfs`|fsys_syncfs]], [[`fsys_syncfs`|fsys_syncfs]] is invoked on all
+active children.