Skip to content

Commit

Permalink
fix format and wording
Browse files Browse the repository at this point in the history
  • Loading branch information
CamStan committed Nov 7, 2023
1 parent 94a59f9 commit 1bb8bc5
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
4 changes: 2 additions & 2 deletions unifyfs-docs/docs/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions unifyfs-docs/docs/link.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 9 additions & 7 deletions unifyfs-docs/docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,14 @@ Quick overview on what UnifyFS is and how to use it.

.. raw:: html

<div style="position: relative; height: 0; overflow: hidden; max-width: 100%; height: auto;">
<div style="position: relative; margin-bottom: 2em; height: 0; overflow: hidden; max-width: 100%; height: auto;">
<iframe width="560" height="315" src="https://www.youtube.com/embed/A_6lG_4EE2M?si=GCcwE3M68fsYUmO_" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>

Tutorial
********
-----

ECP Tutorial
************

More in-depth recording of the problems UnifyFS solves and a how-to using a
pre-1.0 beta version.
Expand All @@ -94,19 +96,19 @@ pre-1.0 beta version.
<iframe width="560" height="315" src="https://www.youtube.com/embed/FmQVJplyVdw?si=_V7f-m_5eOLe90eT" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>

.. 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 <slides/UnifyFS-tutorial-May2022.pdf>`.
:download:`Download PDF <slides/UnifyFS-tutorial-May2022.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.
Expand Down

0 comments on commit 1bb8bc5

Please sign in to comment.