Skip to content

Update deprecated underscore CLI flags in README#31

Open
parkour86 wants to merge 1 commit into
EpixZone:mainfrom
parkour86:docs/update-deprecated-cli-flags
Open

Update deprecated underscore CLI flags in README#31
parkour86 wants to merge 1 commit into
EpixZone:mainfrom
parkour86:docs/update-deprecated-cli-flags

Conversation

@parkour86
Copy link
Copy Markdown

Summary

Updates the README to use the new dash-style CLI flags, eliminating deprecation warnings emitted by Config.fixArgs when users follow the documented examples.

Motivation

Running EpixNet with the flags as documented currently produces warnings such as:

WARNING: using deprecated flag in command line: --tor_controller should be --tor-controller
WARNING: using deprecated flag in command line: --tor_proxy should be --tor-proxy
Support for deprecated flags might be removed in the future

Since support for the underscore variants may be removed in the future, the documentation should steer users toward the supported syntax.

Changes

Replaced underscore flags with their dashed equivalents in README.md:

  • --tor_proxy--tor-proxy
  • --tor_controller--tor-controller
  • --ui_port--ui-port
  • --data_dir--data-dir

Notes

  • Documentation-only change; no code or behavior is affected.
  • The deprecated flags still work at runtime, so this is non-breaking for existing users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant