doc/flux_kvs_lookup(3): add flux_kvs_lookup_get_dir

flux-framework · Oct 11, 2017 · 4e2b9b8 · 4e2b9b8
1 parent 4c85663
commit 4e2b9b8
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/doc/man3/Makefile.am b/doc/man3/Makefile.am
@@ -127,6 +127,7 @@ MAN3_FILES_SECONDARY = \
 	flux_kvs_lookup_get.3 \
 	flux_kvs_lookup_get_unpack.3 \
 	flux_kvs_lookup_get_raw.3 \
+	flux_kvs_lookup_get_dir.3 \
 	flux_kvs_fence.3 \
 	flux_kvs_txn_destroy.3 \
 	flux_kvs_txn_put.3 \
@@ -236,6 +237,7 @@ flux_kvs_lookupat.3: flux_kvs_lookup.3
 flux_kvs_lookup_get.3: flux_kvs_lookup.3
 flux_kvs_lookup_get_unpack.3: flux_kvs_lookup.3
 flux_kvs_lookup_get_raw.3: flux_kvs_lookup.3
+flux_kvs_lookup_get_dir.3: flux_kvs_lookup.3
 flux_kvs_fence.3: flux_kvs_commit.3
 flux_kvs_txn_destroy.3: flux_kvs_txn_create.3
 flux_kvs_txn_put.3: flux_kvs_txn_create.3

diff --git a/doc/man3/flux_kvs_lookup.adoc b/doc/man3/flux_kvs_lookup.adoc
@@ -5,7 +5,7 @@ flux_kvs_lookup(3)
 
 NAME
 ----
-flux_kvs_lookup, flux_kvs_lookupat, flux_kvs_lookup_get, flux_kvs_lookup_get_unpack, flux_kvs_lookup_get_raw - look up KVS key
+flux_kvs_lookup, flux_kvs_lookupat, flux_kvs_lookup_get, flux_kvs_lookup_get_unpack, flux_kvs_lookup_get_raw, flux_kvs_lookup_get_dir - look up KVS key
 
 
 SYNOPSIS
@@ -23,6 +23,8 @@ SYNOPSIS
 
  int flux_kvs_lookup_get_raw (flux_future_t *f, const void **data, int *len);
 
+ int flux_kvs_lookup_get_dir (flux_future_t *f, const flux_kvsdir_t **dir);
+
 
 DESCRIPTION
 -----------
@@ -53,6 +55,9 @@ the returned JSON is parsed according to variable arguments in Jansson
 `flux_kvs_lookup_get_raw()` is identical to `flux_kvs_lookup_get()` except
 the raw value is returned without decoding.
 
+`flux_kvs_lookup_get_dir()` is identical to `flux_kvs_lookup_get()` except
+a directory object is returned.
+
 These functions may be used asynchronously.
 See `flux_future_then(3)` for details.
 

diff --git a/doc/test/spell.en.pws b/doc/test/spell.en.pws
@@ -400,3 +400,4 @@ symlink
 nprocs
 procs
 txn
+kvsdir
-Original file line number
+Diff line change
@@ Expand Up / @@ -400,3 +400,4 @@ symlink @@
     nprocs
     procs
     txn
+    kvsdir