doc/flux_kvs_txn_create(3): add flux_kvs_txn_vpack

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

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/doc/man3/Makefile.am b/doc/man3/Makefile.am
@@ -132,6 +132,7 @@ MAN3_FILES_SECONDARY = \
 	flux_kvs_txn_destroy.3 \
 	flux_kvs_txn_put.3 \
 	flux_kvs_txn_pack.3 \
+	flux_kvs_txn_vpack.3 \
 	flux_kvs_txn_mkdir.3 \
 	flux_kvs_txn_unlink.3 \
 	flux_kvs_txn_symlink.3 \
@@ -242,6 +243,7 @@ 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
 flux_kvs_txn_pack.3: flux_kvs_txn_create.3
+flux_kvs_txn_vpack.3: flux_kvs_txn_create.3
 flux_kvs_txn_mkdir.3: flux_kvs_txn_create.3
 flux_kvs_txn_unlink.3: flux_kvs_txn_create.3
 flux_kvs_txn_symlink.3: flux_kvs_txn_create.3

diff --git a/doc/man3/flux_kvs_txn_create.adoc b/doc/man3/flux_kvs_txn_create.adoc
@@ -5,7 +5,7 @@ flux_kvs_txn_create(3)
 
 NAME
 ----
-flux_kvs_txn_create, flux_kvs_txn_destroy, flux_kvs_txn_put, flux_kvs_txn_pack, flux_kvs_txn_mkdir, flux_kvs_txn_unlink, flux_kvs_txn_symlink, flux_kvs_txn_put_raw - operate on a KVS transaction object
+flux_kvs_txn_create, flux_kvs_txn_destroy, flux_kvs_txn_put, flux_kvs_txn_pack, flux_kvs_txn_vpack, flux_kvs_txn_mkdir, flux_kvs_txn_unlink, flux_kvs_txn_symlink, flux_kvs_txn_put_raw - operate on a KVS transaction object
 
 
 SYNOPSIS
@@ -22,6 +22,9 @@ SYNOPSIS
  int flux_kvs_txn_pack (flux_kvs_txn_t *txn, int flags,
                         const char *key, const char *fmt, ...);
 
+ int flux_kvs_txn_vpack (flux_kvs_txn_t *txn, int flags,
+                         const char *key, const char *fmt, va_list ap);
+
  int flux_kvs_txn_mkdir (flux_kvs_txn_t *txn, int flags,
                          const char *key);
 
@@ -59,7 +62,8 @@ equivalent to calling `flux_kvs_txn_unlink()` on _key_.
 
 `flux_kvs_txn_pack()` is identical to `flux_kvs_txn_put()`, except
 `json_pack()` style arguments (see below) are used to construct the
-value.
+value.  `flux_kvs_txn_vpack()` is a variant that accepts a _va_list_
+argument.
 
 `flux_kvs_txn_mkdir()` sets _key_ to an empty directory.
 

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