From 1bb8bc560424d386fcad21692ed0a4b097a5bf36 Mon Sep 17 00:00:00 2001 From: CamStan Date: Tue, 7 Nov 2023 12:39:56 -0800 Subject: [PATCH] fix format and wording --- unifyfs-docs/docs/build.rst | 4 ++-- unifyfs-docs/docs/link.rst | 6 ++++-- unifyfs-docs/docs/overview.rst | 16 +++++++++------- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/unifyfs-docs/docs/build.rst b/unifyfs-docs/docs/build.rst index 56cb3cf..b6f788b 100644 --- a/unifyfs-docs/docs/build.rst +++ b/unifyfs-docs/docs/build.rst @@ -143,7 +143,7 @@ configure and build UnifyFS from its source code directory. $ gotcha_install=$(spack location -i gotcha) $ spath_install=$(spack location -i spath) $ - $ ./autogen.sh # not needed if using release tarball + $ ./autogen.sh # skip if using release tarball $ ./configure --prefix=/path/to/install --with-gotcha=${gotcha_install} --with-spath=${spath_install} $ make $ make install @@ -200,7 +200,7 @@ As an example, the commands may look like: $ export PKG_CONFIG_PATH=$INSTALL_DIR/lib/pkgconfig:$INSTALL_DIR/lib64/pkgconfig:$PKG_CONFIG_PATH $ export LD_LIBRARY_PATH=$INSTALL_DIR/lib:$INSTALL_DIR/lib64:$LD_LIBRARY_PATH - $ ./autogen.sh # omit if using release tarball + $ ./autogen.sh # skip if using release tarball $ ./configure --prefix=/path/to/install CPPFLAGS=-I/path/to/install/include LDFLAGS="-L/path/to/install/lib -L/path/to/install/lib64" $ make $ make install diff --git a/unifyfs-docs/docs/link.rst b/unifyfs-docs/docs/link.rst index f58fbdc..4cc2c6b 100644 --- a/unifyfs-docs/docs/link.rst +++ b/unifyfs-docs/docs/link.rst @@ -86,13 +86,15 @@ Note the use of the ``-I`` option to specify the location of the library provides the Fortran bindings for the ``unifyfs_mount`` and ``unifyfs_unmount`` functions. +---------- + ---------- LD_PRELOAD ---------- In the case where an application doesn't need to be rebuilt in order to use -UnifyFS or to update any file paths, ``LD_PRELOAD`` can be used at runtime to -allow for UnifyFS interception of file I/O. +UnifyFS (e.g., files paths are set wth arguments/configs), ``LD_PRELOAD`` can be +used at runtime to allow for UnifyFS interception of file I/O. .. code-block:: Bash diff --git a/unifyfs-docs/docs/overview.rst b/unifyfs-docs/docs/overview.rst index 026377c..dae6a9a 100644 --- a/unifyfs-docs/docs/overview.rst +++ b/unifyfs-docs/docs/overview.rst @@ -78,12 +78,14 @@ Quick overview on what UnifyFS is and how to use it. .. raw:: html -
+
-Tutorial -******** +----- + +ECP Tutorial +************ More in-depth recording of the problems UnifyFS solves and a how-to using a pre-1.0 beta version. @@ -94,19 +96,19 @@ pre-1.0 beta version.
-.. rubric:: UnifyFS Tutorial Slides - May 2022 +.. rubric:: UnifyFS Tutorial Slides - ECP 2022 .. image:: images/UnifyFS-tutorial-May2022.png :target: slides/UnifyFS-tutorial-May2022.pdf :height: 72px :align: left - :alt: UnifyFS Tutorial Slides - May 2022 + :alt: UnifyFS Tutorial Slides - ECP 2022 -:download: `Download PDF `. +:download:`Download PDF `. | -.. rubric:: May 2022 Tutorial Corrections: +.. rubric:: Changes since above ECP 2022 Tutorial: - Video 30:04 | Slide 19 - Variants ``boostsys`` and ``preload`` have since been added.