refactor(config): add a detailed comments structure to config.conf file#6612
refactor(config): add a detailed comments structure to config.conf file#6612FrancescoDiMuro wants to merge 30 commits intotronprotocol:developfrom
Conversation
…astForward and seed nodes
|
Recommendation: This PR should be split into two separate PRs
|
Thank you for the feedback. To avoid creating a new PR, what do you think if I just restore the original config.conf's original values? Thank you again. |
|
I strongly support this PR, having such detailed documentation directly in the config file will significantly improve developer experience while deploying a TRON node (we have received several inquiries around the config file in the past from dev community in telegram). I would recommend to eventually create a similar PR in the Nile testnet repo as well. Thanks for your support on drafting this PR @FrancescoDiMuro ! |
…FrancescoDiMuro/java-tron into feature/config-file-refactoring
Contributors using vim, emacs, IntelliJ, Sublime, and other editors, where those prefixes render as meaningless noise. Yes, the original values in the configuration file should not be changed in this pull request; if changes are required, please submit a separate pull request. |
halibobo1205
left a comment
There was a problem hiding this comment.
Thanks for the contribution! The intention to improve documentation is appreciated, but there are several issues that need to be addressed before this can move forward:
-
If the goal is purely to improve documentation, the PR should only modify comments without changing any configuration values, structure, or removing existing configuration blocks. Currently, this PR silently changes several default values (e.g.,
net.type,connection.timeout,minConnections,vm.supportConstant,event.subscribe.version, etc.), removes the 27 mainnet genesis witnesses, empties the fastForward node list, and shifts committee parameters from mainnet to private-net defaults. These are runtime behavior changes, not documentation improvements. -
There are merge conflicts that need to be resolved. Please rebase or merge with the latest
developbranch. -
Please address the above issues before continuing the review process. It is recommended to convert this PR to draft status until the changes are reworked to be comment-only modifications.
What does this PR do?
This PR introduces a detailed and standardized commenting convention for the
config.conffile.It uses Visual Studio Code’s Better Comments extension to visually distinguish between different types of comments, improving readability and maintainability.
Why are these changes required?
The configuration file previously lacked explanations and a consistent structure for comments, making it harder to quickly identify critical notes versus general documentation.
By introducing categorized comment prefixes (
!,*,?), developers can more efficiently scan the file, understand the purpose of each section, and identify important warnings or references at a glance.This PR has been tested by: myself
Follow up
Extra details
!→ Important comments (warnings / required attention, always followed by “Please note”)*→ Informational comments (context, no action required)?→ Reference comments (links, documentation, additional resources)