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

Prepare for upcoming *.txt -> *.adoc bulk rename #1944

Open
dscho opened this issue Jan 27, 2025 · 0 comments
Open

Prepare for upcoming *.txt -> *.adoc bulk rename #1944

dscho opened this issue Jan 27, 2025 · 0 comments

Comments

@dscho
Copy link
Member

dscho commented Jan 27, 2025

There is a proposed patch series to rename the *.txt files in Documentation/ to *.adoc.

Where *.txt files are available, people frequently run various commands to parse and consume them, including tooling for static websites as this one. Which means that such a rename breaks that tooling.

I agree that this would have been a nice feature to add at the beginning of the development of the documentation, but I fear that it is too late to make an incompatible change now. However, as opposed to increasing Git's safety stance, the convenience of a few who want to have syntax highlighting in editors based on the file extension apparently is important enough to merit just such an incompatible change.

This means that script/update-docs.rb will need to be adapted once the tooling here breaks. Or before it. If someone volunteers.

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

No branches or pull requests

1 participant