[llvm-dev] [RFC] changing variable naming rules

Mon Sep 9 07:59:42 PDT 2019

It’s hard to expect 100% consistency in a project with this many contributors, especially when they are not a part of the same organization.  What matters to me is whether I have to apply a different convention to something I’ve seen/written somewhere else.  This mostly applies to global objects, APIs.  Whether a loop in some function uses capital or lowercase ‘i’ is not quite as relevant.  The only persistent inconsistency that I keep seeing is the naming of functions: some historical APIs use UpperCamel, while the rest uses lowerCamel.

I think that a better way forward is to keep a closer eye on consistency in new code.  The older code tends to be rewritten every now and then, and the inconsistencies could be addressed at that time.  The global APIs could be renamed in one shot, but that would be a change that is nowhere near as invasive.

--
Krzysztof Parzyszek  kparzysz at quicinc.com<mailto:kparzysz at quicinc.com>   AI tools development

From: paul.robinson at sony.com <paul.robinson at sony.com>
Sent: Monday, September 9, 2019 9:12 AM
To: Krzysztof Parzyszek <kparzysz at quicinc.com>; clattner at nondot.org; listmail at philipreames.com
Cc: llvm-dev at lists.llvm.org
Subject: [EXT] RE: [llvm-dev] [RFC] changing variable naming rules

Krzysztof Parzyszek wrote:
LLVM’s naming style is _consistent_

Sorry, but *none* of the LLVM naming conventions are consistently used project-wide. There are lots of "historical" exceptions, and  that is mainly because people got excited about "too much churn" which *enshrines inconsistency.*

Applying a tool project-wide will be a step forward in consistency, which I personally think is a good thing.  I had the sad experience, early in my career, of maintaining a code base where you might see 3 different conventions used in the space of a dozen lines of code.  LLVM isn't *that* bad, but moving from one library to another can make it easy to forget that there is, if only in principle, a naming convention.

As a downstream maintainer, I'm well aware any change can cause trouble.  People who do big-bang merges once a release (which we used to do) already have a lot to contend with; IMO the incremental pain is small in that case.  Rui's procedure for fixing up identifiers in a downstream repo did work for us, so I am comfortable saying the cost is annoying but not intolerable.

Re. the upstream release branches, certainly waiting until after 9.0 is final would be best.
--paulr

From: llvm-dev [mailto:llvm-dev-bounces at lists.llvm.org] On Behalf Of Krzysztof Parzyszek via llvm-dev
Sent: Monday, September 09, 2019 9:42 AM
To: Chris Lattner; Philip Reames; llvm-dev at lists.llvm.org<mailto:llvm-dev at lists.llvm.org>
Subject: Re: [llvm-dev] [RFC] changing variable naming rules

LLVM has hundreds of downstream repos, including cases where LLVM is a part of some other project.  There is no zero cost here.

Whether the changes result in meaningful improvements is debatable.  They were motivated by arguments about code readability for people new to the project.  While that’s important, getting acquainted with every new code base is a bit of a challenge.  LLVM’s naming style is _consistent_ and is easy to get used to (unless someone’s harboring a resentment for it).

“Too much churn” can be used as an excuse, but that doesn’t invalidate it as an argument.  I think that in this case it is justified.  Renaming variables is nothing like upgrading the code to use a C++14 feature, for example.

If there is a last-ditch effort to stop this, I’m joining it.

--
Krzysztof Parzyszek  kparzysz at quicinc.com<mailto:kparzysz at quicinc.com>   AI tools development

From: llvm-dev <llvm-dev-bounces at lists.llvm.org<mailto:llvm-dev-bounces at lists.llvm.org>> On Behalf Of Chris Lattner via llvm-dev
Sent: Sunday, September 8, 2019 12:35 AM
To: Philip Reames <listmail at philipreames.com<mailto:listmail at philipreames.com>>
Cc: llvm-dev <llvm-dev at lists.llvm.org<mailto:llvm-dev at lists.llvm.org>>
Subject: [EXT] Re: [llvm-dev] [RFC] changing variable naming rules

What cost do you see here?  Rui has done a significant amount of work to make this effectively zero cost.

The improvements are meaningful, and (as was discussed on the other threads) pretty much every large scale change in the LLVM world has been shot down with objections like “it is too much churn”.

This is a huge problem, because it leads to stagnation in the codebase and does not allow modernization.  LLVM has always had the development philosophy of "trying to be the best”, even if it comes at a cost.  The unwillingness to maintain a stable C++ API is one very significant aspect of this.

I don’t see how this case is any different.

-Chris

On Sep 7, 2019, at 3:32 PM, Philip Reames via llvm-dev <llvm-dev at lists.llvm.org<mailto:llvm-dev at lists.llvm.org>> wrote:

I do not support this.  I feel the benefit is low, and the churn cost is high.
I'm not strongly opposed or anything, I just don't believe this is worthwhile.
Philip
On 9/3/2019 8:14 PM, Rui Ueyama via llvm-dev wrote:
Hi all,

To get wider visibility, build a broader consensus and address concerns on this topic, I'm again raising this as an RFC. This is a proposal to change the rule for variable names from CamelCase to camelBack _really this time_.

Background:

This has been proposed several times on this mailing list in the past. Most recent one was by Michael Platings in February this year [1], and there seems to be a general consensus that the status quo is not ideal.

In the previous RFC thread, I nominated lld [2] as a starter project for renaming and made a sweeping change to rename variables in a few commits. This renaming went well -- even though it broke buildbots, I managed to unbreak them in a timely manner, and more importantly, it has been reported that several downstream repos have successfully migrated to the new naming scheme using a tool that I wrote to create sweeping changes. That being said, some claimed that the renaming attempt didn't get enough attention, despite being discussed in a thread that has 100+ emails. So I'm raising this topic as a new thread.

I propose we do the same thing to another relatively small subproject, clang-tools-extras, to gain more experience, and then migrate the entire LLVM codebase to the new style. It seems technically doable, and even though it would cause a short-term pain, people seem to feel more comfortable with the new naming scheme than the current one. I also believe that the migration won't be that painful.

Objectives:

 - Migrating the entire LLVM repo including subprojects to the new naming scheme without breaking them.
 - Many projects, especially LLVM and Clang have lots of out-of-tree downstream repos. We need to provide a tool to rebase such repos to a commit after a renaming.
 - The sweeping change shouldn't break `git blame`.

What I learned from the lld's naming scheme change:

 - There are many member variables in the LLVM/lld codebase that have the same name as accessors ignoring case (i.e. many classes define foo() as an accessor to a member variable Foo). Such variables would conflict with functions after renaming, so we had to rename accessors by prepending `get`.

 - A single large sweeping change seemed to work better than small incremental changes for downstream repos. Downstream repo maintainers rebased their trees to a commit just prior to the sweeping change, apply my tool to rename all variables in their trees, and then rebase the trees onto the sweeping change. Because the tool creates the same diffs for existing code, downstream maintainers basically only had to merge their diffs at the last step.
 - Even though my tool worked satisfactory, it couldn't rewrite code that are excluded by #if, #ifdef and the like, because the clang-based tool doesn't really see the code excluded by the preprocessor. That caused several buildbot breakages.
 - git 2.23 (released in August) added a new option `--ignore-revs` to `git blame` so that the command can take a list of commits that need to be ignored by blame. Developers can set a default ignore file (typically named `.git-blame-ignore-revs`) using `git config` so that blame automatically ignores commits listed in the file. As far as I tried, that command worked pretty well to ignore the sweeping change I made to lld, so the `git blame` issue seems a solved problem now.

Migration plan:

Given the above findings, I propose we migrate to the new coding style in the following steps.

 1. Change the codebase to eliminate name duplication between accessors and members. This can be done incrementally with as many commits as we want.
 2. Complete the tool and apply it to the entire LLVM tree. I'll publish it at GitHub so that people can take a look and try it out.
 3. Setup buildbots so that they checkout my GitHub tree, build it and run its tests, to make sure that a sweeping change won't break them. (I don't know how to configure buildbots, but I presume this step is doable.)
 4. Give a heads-up and submit a sweeping change to clang-tools-extras, and make sure that that won't break anything.
 5. Give a heads-up and submit a sweeping change to the entire LLVM.

I'd like to submit a sweeping change after LLVM migrates to GitHub to minimize confusion.

[1] http://lists.llvm.org/pipermail/llvm-dev/2019-February/130083.html
[2] https://github.com/llvm/llvm-project/tree/master/lld
[3] https://github.com/llvm/llvm-project/commit/3837f4273fcc40cc519035479aefe78e5cbd3055

_______________________________________________

LLVM Developers mailing list

llvm-dev at lists.llvm.org<mailto:llvm-dev at lists.llvm.org>

https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev
_______________________________________________
LLVM Developers mailing list
llvm-dev at lists.llvm.org<mailto:llvm-dev at lists.llvm.org>
https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20190909/05e98194/attachment.html>