pruning-block-confirmations and pruning-blocks-retained options docum…

…ented (#242) * pruning-block-confirmations and pruning-blocks-retained options documented Signed-off-by: grantnoble <grant.noble@consensys.net> * Updated description for pruning-block-confirmations Signed-off-by: grantnoble <grant.noble@consensys.net> * remove EOL spaces Signed-off-by: grantnoble <grant.noble@consensys.net>
hyperledger · Mar 20, 2020 · 7d4662a · 7d4662a
1 parent 8a1f986
commit 7d4662a
Showing 1 changed file with 63 additions and 0 deletions.
diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md
@@ -1415,6 +1415,69 @@ The URL on which the
 [Orion node](../../Tutorials/Privacy/Configuring-Privacy.md#4-create-orion-configuration-files) is
 running.
 
+### pruning-block-confirmations
+
+!!! caution
+
+    Do not use pruning in Hyperledger Besu v1.4.0. Pruning has a
+    [known bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues).
+
+    If using fast sync in v1.4.0, explicitly disable pruning using `--pruning-enabled=false`.
+
+```bash tab="Syntax"
+--pruning-block-confirmations=<INTEGER>
+```
+
+```bash tab="Command Line"
+--pruning-block-confirmations=5
+```
+
+```bash tab="Environment Variable"
+BESU_PRUNING_BLOCK_CONFIRMATIONS=5
+```
+
+```bash tab="Configuration File"
+pruning-block-confirmations=5
+```
+
+The minimum number of confirmations on a block before marking of newly-stored or in-use state trie
+nodes that cannot be pruned. The default is 10.
+
+!!! important
+    Using pruning with [private transactions](../../Concepts/Privacy/Privacy-Overview.md) is not
+    supported.
+
+### pruning-blocks-retained
+
+!!! caution
+
+    Do not use pruning in Hyperledger Besu v1.4.0. Pruning has a
+    [known bug](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md#known-issues).
+
+    If using fast sync in v1.4.0, explicitly disable pruning using `--pruning-enabled=false`.
+
+```bash tab="Syntax"
+--pruning-blocks-retained=<INTEGER>
+```
+
+```bash tab="Command Line"
+--pruning-blocks-retained=10000
+```
+
+```bash tab="Environment Variable"
+BESU_PRUNING_BLOCKS_RETAINED=10000
+```
+
+```bash tab="Configuration File"
+pruning-blocks-retained=10000
+```
+
+The minimum number of recent blocks to keep the entire world state for. The default is 1024.
+
+!!! important
+    Using pruning with [private transactions](../../Concepts/Privacy/Privacy-Overview.md) is not
+    supported.
+
 ### pruning-enabled
 
 !!! caution