<div dir="ltr"><div dir="ltr">On Wed, Aug 18, 2021 at 4:50 PM Fāng-ruì Sòng via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org">llvm-dev@lists.llvm.org</a>> wrote:<br></div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hi all,<br>
<br>
I created a .clang-tidy patch <a href="https://reviews.llvm.org/D108265" rel="noreferrer" target="_blank">https://reviews.llvm.org/D108265</a> to push<br>
the variable naming related options from<br>
top-level .clang-tidy down to the projects actually using the style<br>
(llvm/, clang-tools-extra/).<br>
<br>
The rationale is: uppercase VariableName doesn't really reflect the<br>
reality for many projects and (in my view) is a bad<br>
suggestion for new projects. My summary about the reality:<br>
<br>
* Use VariableName and have readability-identifier-naming check: llvm,<br>
clang-tools-extra, parallel-libs, polly<br>
* Use VariableName but disable readability-identifier-naming: clang<br>
* Use lowercase variable names and disable<br>
readability-identifier-naming: (mostly lowercase) compiler-rt, flang,<br>
lldb<br>
* Use lowercase variable names and enable<br>
readability-identifier-naming: libc, libclc, libcxx, libcxxabi,<br>
libunwind, lld, mlir, openmp, pstl<br>
<br>
(I noticed the issue because some Phabricator bot wanted me to use<br>
VariableName for a libunwind patch of mine.<br>
The request looked unreasonable to me. I could add<br>
libunwind/.clang-tidy, but I figured out the top-level .clang-tidy<br>
problem.)<br>
<br>
>From my vague memory about previous discussion on variable names, most<br>
people agree that VariableName was a mistake and new projects do not<br>
necessarily need to follow.<br></blockquote><div><br></div><div>Might be worth going back over those discussions and summarizing/linking to supporting archives, etc, so we don't rehash the whole conversation again here? (& cc'ing interested parties so they don't have to stumble across this thread or miss it by accident)</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
However, one feedback is that<br>
<a href="https://llvm.org/docs/CodingStandards.html#name-types-functions-variables-and-enumerators-properly" rel="noreferrer" target="_blank">https://llvm.org/docs/CodingStandards.html#name-types-functions-variables-and-enumerators-properly</a><br>
says<br>
<br>
> Variable names should be nouns (as they represent state). The name should be camel case, and start with an uppercase letter (e.g. Leader or Boats).<br>
<br>
so the top-level .clang-tidy should keep the `VariableName` suggestion<br>
and should apply to new top-level projects.<br>
<br>
Request<br>
=======<br>
<br>
I would like to get feedback on the following two points:<br>
<br>
1. Should we proceed with the .clang-tidy change<br>
<a href="https://reviews.llvm.org/D108265" rel="noreferrer" target="_blank">https://reviews.llvm.org/D108265</a> ?<br>
2. Should the VariableName wording on CodingStandards.html be<br>
clarified/relaxed? llvm, clang, and clang-tools-extra can keep using<br>
it but lowercase names should also be allowed.<br></blockquote><div><br>Further thought: I don't think (1) should proceed as-is no matter the decision on (2). We should have an LLVM umbrella naming convention (I don't think the number of projects that use one or the other should be a vote in favor or against - LLVM Core is still the core of the umbrella project and has more weight here than other subprojects (not the only thing that matters, but part of it), removing any naming convention I think would be unhelpful.<br><br>& I don't think (2) should be "use either of these naming conventions" it should be "this is the naming convention" perhaps with a note that LLVM Core (& some other places, such as clang-tools-extra) uses a different one for historical reasons, for instance. </div></div></div>