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

Restructure repository and add documentation #693

Merged

Conversation

nathanchance
Copy link
Member

@nathanchance nathanchance commented Jan 27, 2024

NOTE: This is currently based on #692 and a separate clean up that depends on that pull. I plan to merge those prior to this one but I wanted to get this out for early review. The series starts at 97b4178.

This pull request reorganizes most of the files in the root of the repository into subfolders for better/clearer organization then adds documentation to describe how all the pieces fit together as well as common maintenance tasks. Comments/concerns welcome!

These two are tightly coupled, so keep them together in the same file.

Signed-off-by: Nathan Chancellor <nathan@kernel.org>
The ChromeOS and KASAN config definitions are tightly coupled to the
main configs file, so keep them together in the same file. If more
config sections need to be added, this makes it quite easy to do so.

Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Now that some files have been combined, rename the files to fill the
numeric gaps.

Signed-off-by: Nathan Chancellor <nathan@kernel.org>
…ob_name()

The next line unconditionally uses build["make_variables"], which makes
the check for make_variables useless, as there would be an exception if
it were not present.

Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Use of make_variables can accomplish the same thing. llvm is only used
in one place and llvm_ias is used nowhere.

Signed-off-by: Nathan Chancellor <nathan@kernel.org>
One step in slimming down the root of the repository

Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Closes: ClangBuiltLinux#689
Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Signed-off-by: Nathan Chancellor <nathan@kernel.org>
Copy link
Contributor

@JustinStitt JustinStitt left a comment

Choose a reason for hiding this comment

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

This is a much nicer structure for the repo. Thanks for this!

I can't quite tell if anything will break from pathing issues but it looks good to me and you changed all the obvious stuff.

@nathanchance
Copy link
Member Author

Thanks a lot for taking a look and double checking!

I am going to merge this as is and close out #692, as this current structure seems okay to me.

If there are any regressions from this, I will address them quickly.

@nathanchance nathanchance merged commit f37c0cd into ClangBuiltLinux:main Jan 29, 2024
7 checks passed
@nathanchance nathanchance deleted the restructure-and-documentation branch January 29, 2024 23:45
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.

None yet

2 participants