docs: update flags with additions, removals, and default changes#536
Closed
vyavdoshenko wants to merge 1 commit into
Closed
docs: update flags with additions, removals, and default changes#536vyavdoshenko wants to merge 1 commit into
vyavdoshenko wants to merge 1 commit into
Conversation
Code Review by Qodo
1. Removed flag still referenced
|
PR Summary by QodoDocs: refresh flag reference (add/remove flags, update defaults) WalkthroughsDescription• Document newly added runtime flags across logging, cluster, IO loops, tiered storage, and serialization. • Remove documentation for deprecated/replaced flags to match current CLI surface. • Update documented defaults for --max_log_size and --rdb_sbf_chunked to reflect current behavior. Diagramgraph TD
U["Operator"] --> D["flags.md"] --> C["CLI flag set"] --> S["Dragonfly server"]
subgraph Legend
direction LR
_p["Person"] ~~~ _doc["Documentation"] ~~~ _cfg["Config surface"]
end
High-Level AssessmentThe approach is appropriate for a docs-only PR: directly update the canonical flags reference to match the current set of supported flags and defaults. Main reviewer focus should be verifying each added/removed flag and default value against the actual CLI/help output or source of truth. File ChangesDocumentation (1)
|
![qodo-free-for-open-source-projects[bot]](https://avatars.githubusercontent.com/in/1068000?s=60&v=4){kind=small}
Comment on lines
-514
to
+517
| ### `--logtostdout` | ||
| Log messages go to stdout instead of logfiles. | ||
| ### `--logbuflevel` | ||
| Buffer log messages logged at this level or below. (-1 means don't buffer; 0 means buffer INFO only). | ||
|
|
||
| `default: false` | ||
| `default: 0` | ||
|
|
||
| ### `--logbufsecs` | ||
| Buffer log messages for at most this many seconds. | ||
|
|
||
| `default: 30` |
There was a problem hiding this comment.
1. Removed flag still referenced 🐞 Bug ≡ Correctness
docs/managing-dragonfly/cluster-mode.md still tells users to pass --logtostdout, but this PR removes --logtostdout from the canonical flags reference page, leaving readers with outdated instructions. Since docsync treats flags missing from the server as obsolete and drops their sections, this reference should be updated to a currently documented logging flag.
Agent Prompt
## Issue description
`docs/managing-dragonfly/cluster-mode.md` instructs users to pass `--logtostdout`, but the flag reference page no longer documents that flag. This makes the cluster-mode troubleshooting guidance inconsistent/outdated.
## Issue Context
The repo’s docsync tooling explicitly deletes sections for flags the server no longer reports, making `flags.md` the canonical surface for “what users can configure”. Any other page referencing removed flags should be updated in the same PR.
## Fix Focus Areas
- docs/managing-dragonfly/cluster-mode.md[193-203]
- docs/managing-dragonfly/flags.md[506-517]
## Suggested fix
Update the note to point to a supported/logically equivalent option that is still documented in `flags.md` (for example `--logtostderr` or `--alsologtostderr`), and keep the wording consistent with how logs appear in the deployment scenario being described.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
|
||
| `default: 0.1` | ||
|
|
||
| ### `--tiered_storage_write_depth` |
There was a problem hiding this comment.
2. Obsolete tiering flag listed 🐞 Bug ≡ Correctness
docs/managing-dragonfly/tiering.md still lists tiered_storage_write_depth as a main tiering flag, but this PR removes that flag’s section from flags.md, leaving readers with a configuration option they can no longer look up. The tiering page should be updated to remove or replace that bullet with the current replacement flag(s).
Agent Prompt
## Issue description
`docs/managing-dragonfly/tiering.md` lists `tiered_storage_write_depth` as a main tiering-related flag, but the central flag reference page no longer documents it. This creates a dead-end for readers trying to configure tiering.
## Issue Context
This PR adds `--tiered_max_pending_stash_bytes` and removes `--tiered_storage_write_depth` from the flag reference. The tiering doc should be updated to reflect the new configuration surface.
## Fix Focus Areas
- docs/managing-dragonfly/tiering.md[32-44]
- docs/managing-dragonfly/flags.md[286-296]
- docs/managing-dragonfly/flags.md[1066-1073]
## Suggested fix
Replace the `tiered_storage_write_depth` bullet with the appropriate replacement (likely `tiered_max_pending_stash_bytes`) and adjust the description to match the new semantics, or remove the bullet if there is no direct replacement.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
--logbuflevel,--logbufsecs,--cluster_coordinator_connect_timeout_ms,--cluster_coordinator_response_timeout_ms,--container_iteration_yield_interval_usec,--enable_memcache_io_loop_v2,--enable_resp_io_loop_v2,--journal_omit_redundant_writes,--listpack_max_bytes,--listpack_max_field_len,--s3_use_helio_client,--serialization_tagged_chunks,--tiered_max_pending_stash_bytes,--use_oah_set--tiered_storage_write_depth,--logtostdout,--experimental_io_loop_v2--max_log_size(1800→200),--rdb_sbf_chunked(false→true)