Skip to content

Commit c2206e8

Browse files
committed
doc: add flux-fsck(1)
Problem: There is no documentation for flux-fsck(1). Add manpage for flux-fsck(1).
1 parent dd1ace2 commit c2206e8

File tree

4 files changed

+68
-0
lines changed

4 files changed

+68
-0
lines changed

doc/Makefile.am

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ MAN1_FILES_PRIMARY = \
2626
man1/flux-getattr.1 \
2727
man1/flux-dmesg.1 \
2828
man1/flux-dump.1 \
29+
man1/flux-fsck.1 \
2930
man1/flux-archive.1 \
3031
man1/flux-content.1 \
3132
man1/flux-config.1 \

doc/man1/flux-fsck.rst

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
============
2+
flux-fsck(1)
3+
============
4+
5+
6+
SYNOPSIS
7+
========
8+
9+
**flux** **fsck** [*OPTIONS*]
10+
11+
12+
DESCRIPTION
13+
===========
14+
15+
.. program flux fsck
16+
17+
The :program:`flux fsck` checks the integrity of the KVS backing
18+
store, starting with the most recent checkpoint (root version) written
19+
to the backing store.
20+
21+
22+
OPTIONS
23+
=======
24+
25+
.. option:: -h, --help
26+
27+
Summarize available options.
28+
29+
.. option:: -v, --verbose
30+
31+
List keys on stderr as they are validated.
32+
33+
.. option:: -q, --quiet
34+
35+
Don't output diagnostic messages and discovered errors.
36+
37+
38+
EXIT STATUS
39+
===========
40+
41+
0
42+
Content store valid
43+
44+
1
45+
One or more errors were discovered
46+
47+
48+
RESOURCES
49+
=========
50+
51+
.. include:: common/resources.rst
52+
53+
54+
FLUX RFC
55+
========
56+
57+
:doc:`rfc:spec_10`
58+
59+
:doc:`rfc:spec_11`
60+
61+
62+
SEE ALSO
63+
========
64+
65+
:man1:`flux-content`, :man1:`flux-kvs`

doc/manpages.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
('man1/flux-cron', 'flux-cron', 'Cron-like utility for Flux', [author], 1),
3131
('man1/flux-dmesg', 'flux-dmesg', 'access broker ring buffer', [author], 1),
3232
('man1/flux-dump', 'flux-dump', 'Write KVS snapshot to portable archive', [author], 1),
33+
('man1/flux-fsck', 'flux-fsck', 'Check integrity of KVS backing store', [author], 1),
3334
('man1/flux-env', 'flux-env', 'Print the flux environment or execute a command inside it', [author], 1),
3435
('man1/flux-event', 'flux-event', 'Send and receive Flux events', [author], 1),
3536
('man1/flux-exec', 'flux-exec', 'Execute processes across flux ranks', [author], 1),

doc/test/spell.en.pws

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -968,3 +968,4 @@ UWjZ
968968
YQ
969969
composable
970970
orchestrator
971+
fsck

0 commit comments

Comments
 (0)