Skip to content

Commit f12fb54

Browse files
chu11mergify[bot]
authored andcommitted
doc: update flux-kvs(1) with sync command
Problem: The new "flux kvs sync" command is not documented. Add documentation in flux-kvs(1).
1 parent bfc973b commit f12fb54

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/man1/flux-kvs.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ SYNOPSIS
2121
| **flux** **kvs** **getroot**
2222
| **flux** **kvs** **version**
2323
| **flux** **kvs** **wait** *version*
24+
| **flux** **kvs** **sync**
2425
2526
| **flux** **kvs** **namespace** **create** [*-o owner*] *name...*
2627
| **flux** **kvs** **namespace** **remove** *name...*
@@ -435,6 +436,16 @@ Block until the KVS version reaches *version* or greater. A simple form
435436
of synchronization between peers is: node A puts a value, commits it,
436437
reads version, sends version to node B. Node B waits for version, gets value.
437438

439+
sync
440+
----
441+
442+
.. program:: flux kvs sync
443+
444+
Flush pending content and checkpoints to disk to ensure data persists
445+
across a Flux instance crash. This command is identical to the
446+
:command:`flux kvs put` :option:`--sync` option, but does not require
447+
any data to be written.
448+
438449
namespace create
439450
----------------
440451

0 commit comments

Comments
 (0)