misc. documentation updates (#32)

* updated to test the latest HDF5 release * update clang-format-lint-action to fix a distutils issue. * updated documentation references
HDFGroup · Sep 26, 2024 · ef5b2b2 · ef5b2b2
1 parent 9c90cc3
commit ef5b2b2
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/.github/workflows/clang-format-check.yml b/.github/workflows/clang-format-check.yml
@@ -9,7 +9,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4.1.1
     - name: Run clang-format style check for C programs.
-      uses: DoozyX/clang-format-lint-action@v0.11
+      uses: DoozyX/clang-format-lint-action@v0.14
       with:
         source: '.'
         extensions: 'c,h,cpp,hpp'

diff --git a/.github/workflows/clang-format-fix.yml b/.github/workflows/clang-format-fix.yml
@@ -10,7 +10,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4.1.1
     - name: Run clang-format style check for C programs.
-      uses: DoozyX/clang-format-lint-action@v0.11
+      uses: DoozyX/clang-format-lint-action@v0.14
       with:
         source: '.'
         extensions: 'c,h,cpp,hpp'

diff --git a/docs/pdf-docs/cache_vol.bib b/docs/pdf-docs/cache_vol.bib
@@ -64,7 +64,7 @@ @article{lammps
 @misc{vol, 
 	title = {{HDF5} {VOL} user guide}, 
 	author = {{The HDF Group}}, 
-	note = {https://hzheng@bitbucket.hdfgroup.org/scm/hdffv/hdf5doc.git, accessed on September 25, 2020}, 
+        note = {https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_h5_v_l__u_g.html#sec_vol, accessed on September 25, 2020},
 }
 
 @misc{async_vol,
@@ -77,7 +77,7 @@ @misc{async_vol
 
 @misc{hdf5, 
   title = {{HDF5}}, 
-  note = {https://portal.hdfgroup.org/display/HDF5/HDF5, accessed on September 25, 2020}
+  note = {https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/index.html, accessed on September 25, 2020}
 }
 
 @article{hacc,

diff --git a/docs/pdf-docs/cache_vol.tex b/docs/pdf-docs/cache_vol.tex
@@ -183,7 +183,7 @@ \subsection{Cache management policy and APIs}
 \subsection{Using local storage cache}
 Finally, in real applications, in order to gain benefit from this local-storage implementation,  one should insert enough compute work between \function{H5Dwrite} /  \function{H5Dread} and \function{H5Dclose}. Below are examples of using the Cache VOL.
 \begin{itemize}
-\item Parallel write \footnote{A complete version of the source code for parallel write: \\https://bitbucket.hdfgroup.org/projects/HDF5VOL/repos/cache/browse/benchmarks/test\_write\_cache.cpp} 
+\item Parallel write \footnote{A complete version of the source code for parallel write: \\https://github.com/HDFGroup/vol-cache/blob/develop/benchmarks/test\_write\_cache.cpp}
 \begin{lstlisting}[language=C++]
 #include "H5LS.h"
 ...
@@ -207,7 +207,7 @@ \subsection{Using local storage cache}
 }
 H5Fclose()
 \end{lstlisting}
-\item Parallel read \footnote{A complete version of the source code for parallel read: \\https://bitbucket.hdfgroup.org/projects/HDF5VOL/repos/cache/browse/benchmarks/test\_read\_cache.cpp} 
+\item Parallel read \footnote{A complete version of the source code for parallel read: \\https://github.com/HDFGroup/vol-cache/blob/develop/benchmarks/test\_read\_cache.cpp}
 \begin{lstlisting}[language=C++]
 #include "H5LS.h"
 //creating local storage variable through property list

diff --git a/docs/source/gettingstarted.rst b/docs/source/gettingstarted.rst
@@ -43,7 +43,7 @@ Installation
 
 .. code-block::
 
-    git clone https://github.com/hpc-io/vol-async.git
+    git clone https://github.com/HDFGroup/vol-async.git
     cd vol-async
     mkdir build
     cd build
@@ -55,7 +55,7 @@ Installation
 
 .. code-block::
 
-    git clone https://github.com/hpc-io/vol-cache.git
+    git clone https://github.com/HDFGroup/vol-cache.git
     cd vol-cache
     mkdir build
     cd build