Preparing for release 0.12

Add version change to build script and man pages
Update documentation

new library versions:
libarchive 3.7.7
dtcmp 1.1.5
lwgrp 1.0.6

Corrected doc and script for libarchive version
It was still pointing to 3.5.1 and now 3.7.7

Fixed url for libraries to pulled down for installation

Updated man and rst with latest version of libraries.

Signed-off-by: Eric Carbonneau <[email protected]>

Author: carbonneau1

dist/builddist

@@ -5,7 +5,7 @@ print_usage() {
     echo ""
     echo "Tags:"
     echo "  main    - build tarball of latest"
-    echo "  v0.11.1 - build tarball of v0.11.1"
+    echo "  v0.12 - build tarball of v0.12"
 }
 
 # check that we got an argument or print usage
@@ -26,10 +26,10 @@ if [ "$1" == "main" ] ; then
 elif [ "$1" == "v0.11.1" ] ; then
     # to build from latest branch of all repos
     ORGS=(
-        "lwgrp"        "llnl" "v1.0.4"
-        "dtcmp"        "llnl" "v1.1.4"
+        "lwgrp"        "llnl" "v1.0.6"
+        "dtcmp"        "llnl" "v1.1.5"
         "libcircle"    "hpc"  "v0.3"
-        "mpifileutils" "hpc"  "v0.11.1"
+        "mpifileutils" "hpc"  "v0.12"
     )
 else
     echo "Error: unknown tag: $1"

doc/rst/build.rst

@@ -26,31 +26,31 @@ https://github.com/hpc/mpifileutils/releases
 mpiFileUtils optionally depends on libarchive, version 3.5.1.
 If new enough, the system install of libarchive may be sufficient,
 though even newer versions may be incompatible with the required version.
-To be certain of compatibility, it is recommended that one install libarchive-3.5.1 with commands like the following
+To be certain of compatibility, it is recommended that one install libarchive-3.7.7 with commands like the following
 
 .. code-block:: Bash
 
    #!/bin/bash
    mkdir install
    installdir=`pwd`/install
 
-   wget https://github.com/libarchive/libarchive/releases/download/v3.5.1/libarchive-3.5.1.tar.gz
-   tar -zxf libarchive-3.5.1.tar.gz
-   cd libarchive-3.5.1
+   wget https://github.com/libarchive/libarchive/releases/download/v3.7.7/libarchive-3.7.7.tar.gz
+   tar -zxf libarchive-3.7.7.tar.gz
+   cd libarchive-3.7.7
      ./configure --prefix=$installdir
      make install
    cd ..
 
 To build on PowerPC, one may need to add :code:`--build=powerpc64le-redhat-linux-gnu` to the configure command.
 
 Assuming libarchive has been installed to an `install` directory as shown above,
-one can then build mpiFileUtils from a release like v0.11.1 with commands like the following:
+one can then build mpiFileUtils from a release like v0.12 with commands like the following:
 
 .. code-block:: Bash
 
-   wget https://github.com/hpc/mpifileutils/releases/download/v0.11.1/mpifileutils-v0.11.1.tgz
-   tar -zxf mpifileutils-v0.11.1.tgz
-   cd mpifileutils-v0.11.1
+   wget https://github.com/hpc/mpifileutils/releases/download/v0.12/mpifileutils-v0.12.tgz
+   tar -zxf mpifileutils-v0.12.tgz
+   cd mpifileutils-v0.12
      mkdir build
      cd build
        cmake .. \
@@ -135,9 +135,9 @@ which can be done with the following commands:
    cd deps
 
      urls=(     https://github.com/hpc/libcircle/releases/download/v0.3/libcircle-0.3.0.tar.gz
-                https://github.com/llnl/lwgrp/releases/download/v1.0.4/lwgrp-1.0.4.tar.gz
-                https://github.com/llnl/dtcmp/releases/download/v1.1.4/dtcmp-1.1.4.tar.gz
-                https://github.com/libarchive/libarchive/releases/download/3.5.1/libarchive-3.5.1.tar.gz
+                https://github.com/llnl/lwgrp/releases/download/v1.0.6/lwgrp-1.0.6.tar.gz
+                https://github.com/llnl/dtcmp/releases/download/v1.1.5/dtcmp-1.1.5.tar.gz
+                https://github.com/libarchive/libarchive/releases/download/v3.7.7/libarchive-3.7.7.tar.gz
      )
 
      rc=0
@@ -160,20 +160,20 @@ which can be done with the following commands:
            make install
          cd ..
 
-         tar -zxf lwgrp-1.0.4.tar.gz
-         cd lwgrp-1.0.4
+         tar -zxf lwgrp-1.0.6.tar.gz
+         cd lwgrp-1.0.6
            ./configure --prefix=$installdir
            make install
          cd ..
 
-         tar -zxf dtcmp-1.1.4.tar.gz
-         cd dtcmp-1.1.4
+         tar -zxf dtcmp-1.1.5.tar.gz
+         cd dtcmp-1.1.5
            ./configure --prefix=$installdir --with-lwgrp=$installdir
            make install
          cd ..
 
-         tar -zxf libarchive-3.5.1.tar.gz
-         cd libarchive-3.5.1
+         tar -zxf libarchive-3.7.7.tar.gz
+         cd libarchive-3.7.7
            ./configure --prefix=$installdir
            make install
          cd ..

doc/rst/conf.py

@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0.11.1'
+version = u'0.12'
 # The full version, including alpha/beta/rc tags.
-release = u'0.11.1'
+release = u'0.12'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

man/dbcast.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DBCAST" "1" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
+.TH "DBCAST" "1" "Jan 29, 2025" "0.12" "mpiFileUtils"
 .SH NAME
 dbcast \- distributed broadcast
 .
@@ -56,7 +56,7 @@ number of MPI processes.
 .TP
 .B \-s, \-\-size SIZE
 The chunk size in bytes used to segment files during the broadcast.
-Units like “MB” and “GB” should be immediately follow the number
+Units like "MB" and "GB" should be immediately follow the number
 without spaces (ex. 2MB). The default size is 1MB. It is recommended
 to use the stripe size of a file if this is known.
 .UNINDENT

man/dbz2.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DBZ2" "1" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
+.TH "DBZ2" "1" "Jan 29, 2025" "0.12" "mpiFileUtils"
 .SH NAME
 dbz2 \- distributed bz2 compression
 .
@@ -64,7 +64,7 @@ Overwrite the output file, if it exists.
 .TP
 .B \-b, \-\-blocksize SIZE
 Set the compression block size, from 1 to 9.
-Where 1=100kB … and 9=900kB. Default is 9.
+Where 1=100kB ... and 9=900kB. Default is 9.
 .UNINDENT
 .INDENT 0.0
 .TP

man/dchmod.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCHMOD" "1" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
+.TH "DCHMOD" "1" "Jan 29, 2025" "0.12" "mpiFileUtils"
 .SH NAME
 dchmod \- distributed tool to set permissions and group
 .
@@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .SH SYNOPSIS
 .sp
-\fBdchmod [OPTION] PATH …\fP
+\fBdchmod [OPTION] PATH ...\fP
 .SH DESCRIPTION
 .sp
 Parallel MPI application to recursively change permissions and/or group
@@ -62,8 +62,8 @@ Change group to specified GROUP name or numeric group id.
 .TP
 .B \-m, \-\-mode MODE
 The mode to apply to each item. MODE may be octal or symbolic syntax
-similar to \fBchmod(1)\fP\&. In symbolic notation, “ugoa” are supported
-as are “rwxX”. As with chmod, if no leading letter “ugoa” is provided,
+similar to \fBchmod(1)\fP\&. In symbolic notation, "ugoa" are supported
+as are "rwxX". As with chmod, if no leading letter "ugoa" is provided,
 mode bits are combined with umask to determine the actual mode.
 .UNINDENT
 .INDENT 0.0
@@ -73,7 +73,7 @@ Attempt to change every item.  By default, dchmod avoids unncessary
 chown and chmod calls, for example trying to change the group
 on an item that already has the correct group, or trying to change
 the group on an item that is not owned by the user running the tool.
-With –force, dchmod executes chown/chmod calls on every item.
+With \-\-force, dchmod executes chown/chmod calls on every item.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -96,7 +96,7 @@ Only modify items whose full path matches REGEX, processed by
 .INDENT 0.0
 .TP
 .B \-n, \-\-name
-Change –exclude and –match to apply to item name rather than its
+Change \-\-exclude and \-\-match to apply to item name rather than its
 full path.
 .UNINDENT
 .INDENT 0.0
@@ -151,7 +151,7 @@ regex:
 .sp
 \fBmpirun \-np 128 dchmod \-\-name \-\-exclude ‘afilename’ \-\-mode u+rw /directory\fP
 .sp
-Note: You can use –match to change file permissions on all of the
+Note: You can use \-\-match to change file permissions on all of the
 files/directories that match the regex.
 .SH SEE ALSO
 .sp

man/dcmp.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCMP" "1" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
+.TH "DCMP" "1" "Jan 29, 2025" "0.12" "mpiFileUtils"
 .SH NAME
 dcmp \- distributed compare
 .
@@ -54,26 +54,26 @@ in which case, each option should provide a different output file name.
 .INDENT 0.0
 .TP
 .B \-t, \-\-text
-Change –output to write files in text format rather than binary.
+Change \-\-output to write files in text format rather than binary.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-b, \-\-base
-Enable base checks and normal stdout results when –output is used.
+Enable base checks and normal stdout results when \-\-output is used.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-bufsize SIZE
-Set the I/O buffer to be SIZE bytes.  Units like “MB” and “GB” may
+Set the I/O buffer to be SIZE bytes.  Units like "MB" and "GB" may
 immediately follow the number without spaces (e.g. 8MB). The default
 bufsize is 4MB.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-chunksize SIZE
 Multiple processes copy a large file in parallel by dividing it into chunks.
-Set chunk to be at minimum SIZE bytes.  Units like “MB” and
-“GB” can immediately follow the number without spaces (e.g. 64MB).
+Set chunk to be at minimum SIZE bytes.  Units like "MB" and
+"GB" can immediately follow the number without spaces (e.g. 64MB).
 The default chunksize is 4MB.
 .UNINDENT
 .INDENT 0.0
@@ -91,6 +91,11 @@ Use O_DIRECT to avoid caching file data.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-\-open\-noatime
+Open files with O_NOATIME flag.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-\-progress N
 Print progress message to stdout approximately every N seconds.
 The number of seconds must be a non\-negative integer.
@@ -125,7 +130,7 @@ Print the command usage, and the list of options available.
 .SH EXPRESSIONS
 .sp
 An expression is made up of one or more conditions, where each condition specifies a field and a state.
-A single condition consists of a field name, an ‘=’ sign, and a state name.
+A single condition consists of a field name, an \(aq=\(aq sign, and a state name.
 .sp
 Valid fields are listed below, along with the property of the entry that is checked.
 .TS
@@ -288,7 +293,7 @@ CONTENT=COMMON => EXISTS=COMMON@TYPE=COMMON@SIZE=COMMON@CONTENT=COMMON
 .sp
 A successful check on any other field also implies that EXIST=COMMON.
 .sp
-When used with the \-o option, one must also specify a file name at the end of the expression, separated with a ‘:’.
+When used with the \-o option, one must also specify a file name at the end of the expression, separated with a \(aq:\(aq.
 The list of any entries that match the expression are written to the named file.
 For example, to list any entries matching the above expression to a file named outfile1,
 one should use the following option:
@@ -303,7 +308,7 @@ one should use the following option:
 .UNINDENT
 .UNINDENT
 .sp
-If the –base option is given or when no output option is specified,
+If the \-\-base option is given or when no output option is specified,
 the following expressions are checked and numeric results are reported to stdout:
 .INDENT 0.0
 .INDENT 3.5

man/dcp.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCP" "1" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
+.TH "DCP" "1" "Jan 29, 2025" "0.12" "mpiFileUtils"
 .SH NAME
 dcp \- distributed copy
 .
@@ -46,22 +46,22 @@ file system, and it splits large file copies across multiple processes.
 .INDENT 0.0
 .TP
 .B \-\-bufsize SIZE
-Set the I/O buffer to be SIZE bytes.  Units like “MB” and “GB” may
+Set the I/O buffer to be SIZE bytes.  Units like "MB" and "GB" may
 immediately follow the number without spaces (e.g. 8MB). The default
 bufsize is 4MB.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-chunksize SIZE
 Multiple processes copy a large file in parallel by dividing it into chunks.
-Set chunk to be at minimum SIZE bytes.  Units like “MB” and
-“GB” can immediately follow the number without spaces (e.g. 64MB).
+Set chunk to be at minimum SIZE bytes.  Units like "MB" and
+"GB" can immediately follow the number without spaces (e.g. 64MB).
 The default chunksize is 4MB.
 .UNINDENT
 .INDENT 0.0
 .TP
 .B \-\-xattrs WHICH
-Copy extended attributes (“xattrs”) from source files to target files.
+Copy extended attributes ("xattrs") from source files to target files.
 WHICH determines which xattrs are copied.  Options are to copy no xattrs,
 all xattrs, xattrs not excluded by /etc/xattr.conf, or all xattrs except
 those which have special meaning to Lustre.  Certain xattrs control Lustre
@@ -104,7 +104,7 @@ that each symbolic link refers to.
 .B \-P, \-\-no\-dereference
 Do not follow symbolic links in source paths. Effectviely allows
 symbolic links to be copied when the link target is not valid
-or there is not permission to read the link’s target.
+or there is not permission to read the link\(aqs target.
 .UNINDENT
 .INDENT 0.0
 .TP
@@ -118,6 +118,11 @@ Use O_DIRECT to avoid caching file data.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-\-open\-noatime
+Open files with O_NOATIME flag.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-S, \-\-sparse
 Create sparse files when possible.
 .UNINDENT
@@ -130,6 +135,18 @@ A value of 0 disables progress messages.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-G, \-\-gid GID
+Set the effective group ID to perform the copy operation. The copy
+may fail if the group does not have sufficient privileges.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-U, \-\-uid UID
+Set the effective user ID to perform the copy operation. The copy
+may fail if the user does not have sufficient privileges.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-v, \-\-verbose
 Run in verbose mode.
 .UNINDENT

man/ddup.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DDUP" "1" "Feb 04, 2022" "0.11.1" "mpiFileUtils"
+.TH "DDUP" "1" "Jan 29, 2025" "0.12" "mpiFileUtils"
 .SH NAME
 ddup \- report files with identical content
 .
@@ -45,6 +45,11 @@ Multiple sets of duplicate files can be matched using this final reported hash.
 .SH OPTIONS
 .INDENT 0.0
 .TP
+.B \-\-open\-noatime
+Open files with O_NOATIME flag, if possible.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-d, \-\-debug LEVEL
 Set verbosity level.  LEVEL can be one of: fatal, err, warn, info, dbg.
 .UNINDENT