Merge branch 'drelncmake'

* drelncmake:
  don't install experimental man pagse
  man pages has it's own cmake
  man page instrutions in doc readme
  added install target to doc/Makefile
  update man pages to v0.9
  make sure GA tool in documentation
  fix some warnings

CMakeLists.txt

@@ -90,6 +90,7 @@ INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR}/src/common)
 
 ADD_SUBDIRECTORY(src)
 ADD_SUBDIRECTORY(test)
+ADD_SUBDIRECTORY(man)
 
 IF(ENABLE_EXPERIMENTAL)
   ADD_SUBDIRECTORY(experimental)

doc/Makefile

@@ -18,3 +18,6 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+install:
+	cp -f build/man/* ../man/

doc/README.md

@@ -3,3 +3,16 @@
 Edits should be made to the `.rst` files.
 The documentation can be built with `make html` or `make man`.
 The generated files will be found in the `build` directory.
+
+## Man Pages
+
+Since there is no guarantee of Sphinx on each system, the man pages for each release are committed directly to the repo.
+This can be done with:
+
+``` shell
+cd doc
+make man
+make install
+```
+
+Be sure to update the version number in the `doc/rst/conf.py` file as well.

doc/rst/conf.py

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

doc/rst/index.rst

@@ -77,17 +77,18 @@ Man Pages
    :maxdepth: 1
 
    dbcast.1
-   dbz2.1
    dchmod.1
    dcmp.1
    dcp.1
    ddup.1
    dfilemaker.1
    dfind.1
+   dreln.1
    drm.1
    dstripe.1
    dsync.1
    dwalk.1
+   experimental/dbz2.1
    experimental/dgrep.1
    experimental/dparallel.1
    experimental/dtar.1

experimental/dsh/dsh.c

@@ -591,7 +591,7 @@ static void sort_scan_sort(mfu_path* origpath, uint64_t allmax,
     /* copy items into buffer */
     uint64_t idx = 0;
     char* ptr = (char*) buf;
-    strmap_node* elem;
+    const strmap_node* elem;
     for (elem  = strmap_node_first(children);
          elem != NULL;
          elem  = strmap_node_next(elem))
@@ -865,7 +865,7 @@ static void summarize_children(mfu_flist flist, mfu_path* path, int print_defaul
     }
 
     /* free data structure allocated for each child */
-    strmap_node* elem;
+    const strmap_node* elem;
     for (elem  = strmap_node_first(children);
          elem != NULL;
          elem  = strmap_node_next(elem))
@@ -1657,7 +1657,7 @@ static char* arg_to_regex(const char* arg)
 {
     /* count number of bytes we need */
     size_t count = 2; /* for ^ and $ at ends of regex */
-    char* str = arg;
+    char* str = (char*)arg;
     char* tok = strchr(str, '*');
     while (tok != NULL) {
       count += tok - str; /* copy text leading up to * */
@@ -1675,7 +1675,7 @@ static char* arg_to_regex(const char* arg)
     strcpy(regex, "^");
 
     /* replace each * with .* */
-    str = arg;
+    str = (char*)arg;
     tok = strchr(str, '*');
     while (tok != NULL) {
       strncat(regex, str, tok - str);
@@ -1815,7 +1815,7 @@ int main(int argc, char** argv)
         paths = (mfu_param_path*) MFU_MALLOC((size_t)numpaths * sizeof(mfu_param_path));
 
         /* process each path */
-        char** argpaths = &argv[optind];
+        const char** argpaths = (const char**)(&argv[optind]);
         mfu_param_path_set_all(numpaths, argpaths, paths);
 
         /* advance to next set of options */

man/CMakeLists.txt

@@ -0,0 +1,16 @@
+LIST(APPEND man_pages
+  dbcast.1
+  dchmod.1
+  dcmp.1
+  dcp.1
+  ddup.1
+  dfilemaker.1
+  dfind.1
+  dreln.1
+  drm.1
+  dstripe.1
+  dsync.1
+  dwalk.1
+  )
+
+INSTALL(FILES ${man_pages} DESTINATION ${X_DATADIR}/man/man1)

man/dbcast.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DBCAST" "1" "Dec 19, 2018" "0.8" "mpiFileUtils"
+.TH "DBCAST" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
 .SH NAME
 dbcast \- distributed broadcast
 .

man/dchmod.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCHMOD" "1" "Dec 19, 2018" "0.8" "mpiFileUtils"
+.TH "DCHMOD" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
 .SH NAME
 dchmod \- distributed tool to set permissions and group
 .

man/dcmp.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCMP" "1" "Dec 19, 2018" "0.8" "mpiFileUtils"
+.TH "DCMP" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
 .SH NAME
 dcmp \- distributed compare
 .
@@ -70,6 +70,15 @@ read, byte rate, and file rate.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-l, \-\-lite
+lite mode does a comparison of file modification time and size. If
+modification time and size are the same, then the contents are assumed
+to be the same. Similarly, if the modification time or size is different,
+then the contents are assumed to be different. The lite mode does no comparison
+of data/content in the file.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-h, \-\-help
 Print the command usage, and the list of options available.
 .UNINDENT

man/dcp.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DCP" "1" "Dec 19, 2018" "0.8" "mpiFileUtils"
+.TH "DCP" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
 .SH NAME
 dcp \- distributed copy
 .

man/ddup.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DDUP" "1" "Dec 19, 2018" "0.8" "mpiFileUtils"
+.TH "DDUP" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
 .SH NAME
 ddup \- report files with identical content
 .

man/dfilemaker.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "DFILEMAKER" "1" "Dec 19, 2018" "0.8" "mpiFileUtils"
+.TH "DFILEMAKER" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
 .SH NAME
 dfilemaker \- distributed random file generation program
 .