Skip to content

Commit 1432eb4

Browse files
committed
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
2 parents 3d42364 + 62fdb92 commit 1432eb4

39 files changed

+968
-458
lines changed

CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR}/src/common)
9090

9191
ADD_SUBDIRECTORY(src)
9292
ADD_SUBDIRECTORY(test)
93+
ADD_SUBDIRECTORY(man)
9394

9495
IF(ENABLE_EXPERIMENTAL)
9596
ADD_SUBDIRECTORY(experimental)

doc/Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ help:
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21+
22+
install:
23+
cp -f build/man/* ../man/

doc/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,16 @@
33
Edits should be made to the `.rst` files.
44
The documentation can be built with `make html` or `make man`.
55
The generated files will be found in the `build` directory.
6+
7+
## Man Pages
8+
9+
Since there is no guarantee of Sphinx on each system, the man pages for each release are committed directly to the repo.
10+
This can be done with:
11+
12+
``` shell
13+
cd doc
14+
make man
15+
make install
16+
```
17+
18+
Be sure to update the version number in the `doc/rst/conf.py` file as well.

doc/rst/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
# built documents.
5555
#
5656
# The short X.Y version.
57-
version = u'0.8'
57+
version = u'0.9'
5858
# The full version, including alpha/beta/rc tags.
59-
release = u'0.8'
59+
release = u'0.9'
6060

6161
# The language for content autogenerated by Sphinx. Refer to documentation
6262
# for a list of supported languages.
File renamed without changes.

doc/rst/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,18 @@ Man Pages
7777
:maxdepth: 1
7878

7979
dbcast.1
80-
dbz2.1
8180
dchmod.1
8281
dcmp.1
8382
dcp.1
8483
ddup.1
8584
dfilemaker.1
8685
dfind.1
86+
dreln.1
8787
drm.1
8888
dstripe.1
8989
dsync.1
9090
dwalk.1
91+
experimental/dbz2.1
9192
experimental/dgrep.1
9293
experimental/dparallel.1
9394
experimental/dtar.1

experimental/dsh/dsh.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,7 @@ static void sort_scan_sort(mfu_path* origpath, uint64_t allmax,
591591
/* copy items into buffer */
592592
uint64_t idx = 0;
593593
char* ptr = (char*) buf;
594-
strmap_node* elem;
594+
const strmap_node* elem;
595595
for (elem = strmap_node_first(children);
596596
elem != NULL;
597597
elem = strmap_node_next(elem))
@@ -865,7 +865,7 @@ static void summarize_children(mfu_flist flist, mfu_path* path, int print_defaul
865865
}
866866

867867
/* free data structure allocated for each child */
868-
strmap_node* elem;
868+
const strmap_node* elem;
869869
for (elem = strmap_node_first(children);
870870
elem != NULL;
871871
elem = strmap_node_next(elem))
@@ -1657,7 +1657,7 @@ static char* arg_to_regex(const char* arg)
16571657
{
16581658
/* count number of bytes we need */
16591659
size_t count = 2; /* for ^ and $ at ends of regex */
1660-
char* str = arg;
1660+
char* str = (char*)arg;
16611661
char* tok = strchr(str, '*');
16621662
while (tok != NULL) {
16631663
count += tok - str; /* copy text leading up to * */
@@ -1675,7 +1675,7 @@ static char* arg_to_regex(const char* arg)
16751675
strcpy(regex, "^");
16761676

16771677
/* replace each * with .* */
1678-
str = arg;
1678+
str = (char*)arg;
16791679
tok = strchr(str, '*');
16801680
while (tok != NULL) {
16811681
strncat(regex, str, tok - str);
@@ -1815,7 +1815,7 @@ int main(int argc, char** argv)
18151815
paths = (mfu_param_path*) MFU_MALLOC((size_t)numpaths * sizeof(mfu_param_path));
18161816

18171817
/* process each path */
1818-
char** argpaths = &argv[optind];
1818+
const char** argpaths = (const char**)(&argv[optind]);
18191819
mfu_param_path_set_all(numpaths, argpaths, paths);
18201820

18211821
/* advance to next set of options */

man/CMakeLists.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
LIST(APPEND man_pages
2+
dbcast.1
3+
dchmod.1
4+
dcmp.1
5+
dcp.1
6+
ddup.1
7+
dfilemaker.1
8+
dfind.1
9+
dreln.1
10+
drm.1
11+
dstripe.1
12+
dsync.1
13+
dwalk.1
14+
)
15+
16+
INSTALL(FILES ${man_pages} DESTINATION ${X_DATADIR}/man/man1)

man/Makefile.am

Lines changed: 0 additions & 11 deletions
This file was deleted.

man/dbcast.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\" Man page generated from reStructuredText.
22
.
3-
.TH "DBCAST" "1" "Dec 19, 2018" "0.8" "mpiFileUtils"
3+
.TH "DBCAST" "1" "Jan 28, 2019" "0.9" "mpiFileUtils"
44
.SH NAME
55
dbcast \- distributed broadcast
66
.

0 commit comments

Comments
 (0)