Skip to content

[NFC] Eliminate need of Emacs tag and file name in file header #118553

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

Merged
merged 1 commit into from
Dec 4, 2024

Conversation

jurahul
Copy link
Contributor

@jurahul jurahul commented Dec 3, 2024

  • Simplify file header to not require file name and C++ Emacs tag.

See https://discourse.llvm.org/t/is-c-in-header-files-still-relevant/83124/1

@jurahul jurahul requested review from nikic and AaronBallman December 3, 2024 23:58
@jurahul
Copy link
Contributor Author

jurahul commented Dec 3, 2024

@nikic and @AaronBallman PTAL at the discourse thread above and see if we want to make this amendment to the coding standards. This does not mean that all files will be immediately updated to strip out the current header, but over time.

@jurahul jurahul marked this pull request as ready for review December 4, 2024 00:02
Copy link
Contributor

@nikic nikic left a comment

Choose a reason for hiding this comment

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

LGTM, the discourse thread has a clear consensus that the emacs marker is no longer necessary, and the file name and impracticably short description are not useful.

@jurahul jurahul changed the title [NFC] Eliminate needs of Emacs tag and file name in file headers [NFC] Eliminate need of Emacs tag and file name in file header Dec 4, 2024
@jurahul
Copy link
Contributor Author

jurahul commented Dec 4, 2024

Thanks. @AaronBallman will wait a couple of days to give you a chance to look as well. Will merge towards EOW.

Copy link
Collaborator

@AaronBallman AaronBallman left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@jurahul jurahul merged commit e2c3d16 into llvm:main Dec 4, 2024
12 checks passed
@jurahul jurahul deleted the file_header_coding_std branch December 4, 2024 16:57
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.

3 participants