commandline-usage: separate stand-alone + initial ledger options #2010
Conversation
…dent Initial Ledger Options is not a subcategory of Stand-Alone Mode Options
| @@ -70,7 +70,7 @@ Daemon mode is the default mode of operation for `rippled`. In addition to the [ | |||
|
|
|||
| The following option has been removed: `--validateShards`. [Removed in: rippled 1.7.0][] | |||
|
|
|||
| ## Stand-Alone Mode Options | |||
| ### Stand-Alone Mode Options | |||
There was a problem hiding this comment.
## Daemon Mode Options
has two ##. Should Stand-Alone Mode Options match that?
There was a problem hiding this comment.
With 4e625a2, updated so both are at the ## level
|
Link check report. 495072 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/stand-alone-vs-initial-ledger/ |
1 similar comment
|
Link check report. 495072 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/stand-alone-vs-initial-ledger/ |
|
I'm not convinced that most of these options work meaningfully in networked mode. Most of the time, the server will disregard whatever initial ledger it loaded if its trusted validators are working on something completely different. In what cases are any of these settings useful in networked mode? |
|
--valid is useful to start the initial validator in a network that needs to be restarted, such as for testing, or something unthinkable. The logic for the fast_load config option uses the same code path as --load, but reads the disk in parallel. I don't know if the others are useful in network mode. |
|
note: conversations with the team suggest that these options are not only for standalone mode |
|
Updated with new information to clarify the uses of these options for starting networks (devnets and sidechains included) as well as debugging. |
|
Link check report. 495078 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/stand-alone-vs-initial-ledger/ |
1 similar comment
|
Link check report. 495078 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/stand-alone-vs-initial-ledger/ |
| | `--replay` | Intended for debugging. Use with `--ledger` to replay a ledger close. Your server must have the ledger in question and its direct ancestor already in the ledger store. Using the previous ledger as a base, the server processes all the transactions in the specified ledger, resulting in a re-creation of the specified ledger. With a debugger, you can add breakpoints to analyze specific transaction processing logic. | | ||
| | `--start` | Intended for debugging. Start with a new genesis ledger that has all known amendments (except those the server is configured to vote against) enabled. This makes the functionality of those amendments available right away, instead of needing to wait two weeks for the [Amendment Process](amendments.html). | | ||
| | `--valid` | **DEPRECATED** Intended for debugging. Consider the initial ledger a valid network ledger even before fully syncing with the network. | | ||
| | `--load` | Use only the ledger store on disk when loading the initial ledger. | |
There was a problem hiding this comment.
are we re-enabling the deprecated options (--load and --valid)?
There was a problem hiding this comment.
yes, my understanding is that those options are no longer considered to be deprecated
|
FWIW, I approve of the commits added by @mDuo13 above |
|
I see, okay
Regards,
Keshava
…On Wed, Aug 9, 2023 at 1:49 PM Elliot Lee ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In content/references/http-websocket-apis/commandline-usage.md
<https://urldefense.com/v3/__https://github.com/XRPLF/xrpl-dev-portal/pull/2010*discussion_r1289180262__;Iw!!PZTMFYE!9VcU-kgJfohAfa6Q8Ylbf7oRN7rkKk1ChiuyQvOhW2yVNx0LLjG9xWthVCiVyjI9NvBfVK75rQYsFIDms2AfGniRxQ$>
:
>
| Option | Description |
|:----------------------|:-----------------------------------------------------|
| `--ledger {LEDGER}` | Load the ledger version identified by `{LEDGER}` (either a ledger hash or a ledger index) as the initial ledger. The specified ledger version must be in the server's ledger store. |
| `--ledgerfile {FILE}` | Load the ledger version from the specified `{FILE}`, which must contain a complete ledger in JSON format. For an example of such a file, see the provided [`ledger-file.json`]({{target.github_forkurl}}/blob/{{target.github_branch}}/content/_api-examples/rippled-cli/ledger-file.json). |
-| `--load` | **DEPRECATED** Intended for debugging. Only load the initial ledger from the ledger store on disk. |
-| `--replay` | Intended for debugging. Use with `--ledger` to replay a ledger close. Your server must have the ledger in question and its direct ancestor already in the ledger store. Using the previous ledger as a base, the server processes all the transactions in the specified ledger, resulting in a re-creation of the specified ledger. With a debugger, you can add breakpoints to analyze specific transaction processing logic. |
-| `--start` | Intended for debugging. Start with a new genesis ledger that has all known amendments (except those the server is configured to vote against) enabled. This makes the functionality of those amendments available right away, instead of needing to wait two weeks for the [Amendment Process](amendments.html). |
-| `--valid` | **DEPRECATED** Intended for debugging. Consider the initial ledger a valid network ledger even before fully syncing with the network. |
+| `--load` | Use only the ledger store on disk when loading the initial ledger. |
yes, my understanding is that those options are no longer considered to be
deprecated
—
Reply to this email directly, view it on GitHub
<https://urldefense.com/v3/__https://github.com/XRPLF/xrpl-dev-portal/pull/2010*discussion_r1289180262__;Iw!!PZTMFYE!9VcU-kgJfohAfa6Q8Ylbf7oRN7rkKk1ChiuyQvOhW2yVNx0LLjG9xWthVCiVyjI9NvBfVK75rQYsFIDms2AfGniRxQ$>,
or unsubscribe
<https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AFB4TNNWVXJYXK5LAPPFYQ3XUPZU5ANCNFSM6AAAAAA2QPFG74__;!!PZTMFYE!9VcU-kgJfohAfa6Q8Ylbf7oRN7rkKk1ChiuyQvOhW2yVNx0LLjG9xWthVCiVyjI9NvBfVK75rQYsFIDms2Aena46PQ$>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
|
Link checker failures are the same ones already fixed in #2041, so this is good to go |
Clarify: Initial Ledger Options is not a subcategory of Stand-Alone Mode Options
@thejohnfreeman @mtrippled @pwang200