Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Main to BookkeeperStarter for Improved Clarity and Context #4328

Closed
wants to merge 1 commit into from

Conversation

shoothzj
Copy link
Member

@shoothzj shoothzj commented May 2, 2024

Fix #2950

Motivation

The current class name org.apache.bookkeeper.server.Main is generic, which makes it less informative about the class's purpose in the context of BookKeeper. This can lead to confusion, especially for new contributors or during debugging sessions. By renaming this class to BookkeeperStarter, we aim to improve code clarity and express the class's role in starting the BookKeeper server more explicitly.

Changes

  • Renamed Main class to BookkeeperStarter in all occurrences within the project.
  • Updated references in scripts, test cases, and Java files to reflect the new class name.
  • Minor cleanups in the BookkeeperStarter class

Copy link
Contributor

@nicoloboschi nicoloboschi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about renaming AutoRecoveryMain to AutoRecoveryStarter in the same PR ?

@shoothzj
Copy link
Member Author

shoothzj commented May 2, 2024

@nicoloboschi I have been considering about this. I prefer open a new PR to do this refactor, since it's name has been related to AutoRecovery

@shoothzj
Copy link
Member Author

shoothzj commented May 3, 2024

Copy link
Contributor

@eolivelli eolivelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly I don't see much value in this change: "Main" is alrady a good name for "the main class"
On the other hand I think that some custom scripts that launch the bookie may fail.

I am -0

Copy link
Contributor

@merlimat merlimat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be good to leave Main for compatibility. eg: in Pulsar codebase we're using the name of the class directly

@shoothzj
Copy link
Member Author

shoothzj commented May 7, 2024

@eolivelli @merlimat Ok, I will close this PR and releated issue. :)

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.

Change org.apache.bookkeeper.server.Main classname,for better recognition.
4 participants