-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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
RFC: reorganize packages layout for this repository #41241
Comments
We are really looking forward to it! And I have some considerations:
|
Yes, I think so.
Well, we have
I don't think we can provide any script(don't know how to do it). I just think that if this is accepted, we will make it on some low-traffic time like weekend. Please let me know if you have any better idea. Update: will make a try. |
This is a related issue. |
@bb7133 Some components are huge and have many codes. But They such as |
This is my suggestion
And do you have any experience can help with moving packages? @amyangfei |
Nope, I think the current proposal requires a lot of changes already. For further changes, we could make them one by one. |
Are we going to update other repos? e.g. https://github.com/pingcap/dumpling/blob/master/README.md and https://github.com/pingcap/tidb-lightning/blob/master/README.md ? I think we should only do that for those that are not archived. this would also needs updates in pingcap/docs and pingcap/docs-cn |
Is there any progress? |
There are some util packages in the BR directory, |
My suggestion:
And what's the differences between |
util is so sommon package. many open source project has util package. https://github.com/prometheus/prometheus/tree/main/util Additionally, utilizing code from the util package as much as possible can enhance development efficiency and improve the quality of code validation across multiple scenarios due to code reuse. server is the server component. in general, it is tidb entry. This is a common naming convention. for example https://github.com/kubernetes/kubernetes/tree/master/pkg/kubelet/server |
I'm trying to provide a script so that when we make the change, the on-going PRs can be updated easily. However, if we make some changes for lightning, my concern is that the script would be complicated. Considering the impact of changing
For the choice of |
About |
@lance6716 I got your point finally: there is For the rest part of |
@wuhuizuo Do you have any suggestion on where we should place packages like |
@dveeden , Yes, of course! |
|
(Comments & suggestions are appreciated!)
Motivation
As you might notice, the codebase of this repository is organized in a ‘flattened’ way: there are 40+ level-1 directories/packages, which, in my option, has the following cons:
(1) It looks tedious.
(2) Similar to (1), the hierarchical structure is not clear enough.
So, here I would like to propose the reorganization of the packages.
The structure
As shown in the figure below, I would like to make the following changes:
br
anddumpling
) totools
directory.tidb-server
package tocmd
directory.pkg
directory, which contains the packages for "TiDB kernel"(most of the level-1 directories today).The text was updated successfully, but these errors were encountered: