summaryrefslogtreecommitdiffstats
path: root/utils/vfd_swmr/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'utils/vfd_swmr/README.md')
m---------utils/vfd_swmr0
-rw-r--r--utils/vfd_swmr/README.md18
2 files changed, 18 insertions, 0 deletions
diff --git a/utils/vfd_swmr b/utils/vfd_swmr
deleted file mode 160000
-Subproject 121da9672cebea43dca05c89adaae5d05ba56e4
diff --git a/utils/vfd_swmr/README.md b/utils/vfd_swmr/README.md
new file mode 100644
index 0000000..dd19c72
--- /dev/null
+++ b/utils/vfd_swmr/README.md
@@ -0,0 +1,18 @@
+# VFD SWMR Utilities
+
+To support NFS file system, this utility applies the updater files to the copy of the metadata file.
+
+Usage: aux_process [options] <md_file> <ud_path>
+
+Where: <md_file> is the path to the metadata file. Must be on a POSIX file system. Note that the file may not exist yet.
+ <ud_path> is the path of the updater files including the directory. This will typically be in an NFS mounted file system.
+
+Options:
+ -a --skip_aux: Exit if VDS across multiple file is being enabled (to be implented in the future).
+ -c --vfd_config: Quoted string containing the configuration string for the VFD stack to be used. Default: sec2
+ -l --log_file: Path to the log file. Default: no log file.
+ -m --md_chksum_path: Path to the file containing the checksum values for testing purpose.
+ -p --polls_per_tick: Number of times to poll for a new updater file per tick. Default: 10.
+ -s --stats: Display stats on exit.
+ -t --tick_len: Integer value indicating the tick length in tenths of a second.
+ -v --verbose: Write log entries to stdout.