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

clang-format documentation has "git" in every title #54207

Open
mydeveloperday opened this issue Mar 4, 2022 · 11 comments
Open

clang-format documentation has "git" in every title #54207

mydeveloperday opened this issue Mar 4, 2022 · 11 comments
Labels
bug Indicates an unexpected problem or unintended behavior clang Clang issues not falling into any other category clang-format documentation

Comments

@mydeveloperday
Copy link
Contributor

image

Not sure why it says '15.0.0git'

@mydeveloperday mydeveloperday added bug Indicates an unexpected problem or unintended behavior clang:documentation clang-format labels Mar 4, 2022
@llvmbot
Copy link
Collaborator

llvmbot commented Mar 4, 2022

@llvm/issue-subscribers-bug

@llvmbot
Copy link
Collaborator

llvmbot commented Mar 4, 2022

@llvm/issue-subscribers-clang-format

@mydeveloperday mydeveloperday changed the title clang-format documentation has this clang-format documentation has "git" in every title Mar 4, 2022
@mydeveloperday
Copy link
Contributor Author

related ? e80c529

@mkurdej
Copy link
Member

mkurdej commented Mar 4, 2022

It's not clang-format specific. IMO it marks that it's not a release documentation.

@tstellar
Copy link
Collaborator

tstellar commented Mar 4, 2022

This is just the version string that the project uses for the main branch. clang --version will report the same thing.

@mydeveloperday
Copy link
Contributor Author

mydeveloperday commented Mar 4, 2022

You are right I didn't see it before... it looks very odd! would it be better to say

15.0.0 (prerelease) or 15.0.0 (trunk)

or something other than git what has git got to do with it?

This just looks bizarre to me.

image

I seriously assumed someone had messed up the conf.py file.

@mydeveloperday
Copy link
Contributor Author

mydeveloperday commented Mar 4, 2022

@tstellar don't get me wrong I like the idea of the documentation having the correct version and no one having to go around and change it every release (that bit is great).

I'm not seeing the "git" that for 'clang-format --version' and if we did I think we might even break some people scripts that check the version because I doubt they'd be expecting to see 0.0git at the end

$ clang-format --version
clang-format version 15.0.0 (https://github.com/llvm/llvm-project.git c88deef
218dd5c30500e7d3f58fc23283d3e5)

Is anyone wedded to this idea of having the word "git" or could we transform it into

" (underdevelopment)", 
" (in-progress)", 
" (trunk)", 
" (main branch)"

at least in the documentation

@tstellar
Copy link
Collaborator

tstellar commented Mar 4, 2022

I have no preference what the version string is, but if we want to change it I think it would require a community wide RFC.

@mydeveloperday
Copy link
Contributor Author

mydeveloperday commented Mar 5, 2022

was there an RFC for the addition of the "git" I could tack onto the back of?

@tstellar
Copy link
Collaborator

tstellar commented Mar 7, 2022

was there an RFC for the addition of the "git" I could tack onto the back of?

I don't think so. I suspect that most people don't care about the git suffix, but any time you change the version string, you risk breaking people's scripts, CI, etc. so that's why I think it needs some kind of higher-visibility than just a patch.

@mydeveloperday
Copy link
Contributor Author

I wasn’t thinking about changing the versioning just have |releasenogit| in the rst

@Endilll Endilll added documentation clang Clang issues not falling into any other category and removed clang:documentation labels Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Indicates an unexpected problem or unintended behavior clang Clang issues not falling into any other category clang-format documentation
Projects
None yet
Development

No branches or pull requests

5 participants