Page MenuHomeHEPForge

Rename member variables to follow convention of m_ prefix
Needs ReviewPublic

Authored by tlatham on Mar 12 2021, 6:20 PM.

Details

Summary

Rename member variables to follow convention of m_ prefix

In addition:

  • Introduce pre-build checks in the CI to
    • Check that clang-format has been applied to all files
    • Check that the member variable naming convention is being followed in all classes
  • Remove unused class EvtDecayParm
  • Remove unused var from EvtXPsiGamma
  • Fix some shadowing of variables
  • Fixes to Doxygen configuration
Test Plan

Run tests for all models using the results of the same tests on master as reference

Diff Detail

Repository
rEVTGEN evtgen
Branch
arcpatch-D58
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 185
Build 185: arc lint + arc unit

Event Timeline

@kreps , @jback feel free to add yourselves as reviewers too
We should also decide whether to extend this to the rest of the package now or leave to later. I'd probably favour doing it all in one go.

tlatham retitled this revision from Started to remove _ to Started to rename member variables to avoid leading underscores.Mar 17 2021, 11:26 AM
tlatham edited the summary of this revision. (Show Details)
tlatham changed the visibility from "All Users" to "Public (No Login Required)".
tlatham changed the edit policy from "All Users" to "Restricted Project (Project)".
tlatham added a project: Restricted Project.
tlatham removed subscribers: jback, kreps.
kreps added a reviewer: averbyts.

I will commandeer and push rest.

  • Rename member variables starting or ending with underscore to m_xxx

I think I have it now all, but I ran to another issue with arcanist, which refused to upload diff on a large file without marking it binary. The file is src/EvtGenModels/EvtVubAC.cpp and we might need to change it back from binary when we finish this.

  • Rename preprocessor macro from _unused to UNUSED
In D58#1640, @kreps wrote:

I think I have it now all, but I ran to another issue with arcanist, which refused to upload diff on a large file without marking it binary. The file is src/EvtGenModels/EvtVubAC.cpp and we might need to change it back from binary when we finish this.

If I use arc patch D58 to apply this diff to my local repo then the file does not seem to be marked binary there.
git diff --numstat master src/EvtGenModels/EvtVubAC.cpp still tells me the number of changed lines as normal:
62814 50650 src/EvtGenModels/EvtVubAC.cpp
while I think for a binary file it would give:
- - src/EvtGenModels/EvtVubAC.cpp
So I guess it's just some internal arcanist/Differential oddness and we don't need to worry about it.

  • Rename member variables starting with underscore to m_xxx
  • Rename variables ending on underscore in EvtGenBase and small cleanup from previous chunk
  • Next part of renaming member variables finishing with underscore.
  • Rename preprocessor macro from _unused to UNUSED
  • Rename member variables starting with underscore to m_xxx
  • Rename variables ending on underscore in EvtGenBase and small cleanup from previous chunk
  • Next part of renaming member variables finishing with underscore.
  • Rename preprocessor macro from _unused to UNUSED
tlatham edited reviewers, added: kreps; removed: tlatham.
  • Fix to include external generator engines in Doxygen
  • Few more manual renames
  • Fix shadow and rename vars in EvtBBScalar
  • Remove unused var from EvtXPsiGamma
  • More renames
  • Final lot of renames
  • Fix indexing in Doxygen to ignore Evt and m_ prefixes
  • Apply clang-format
  • Fix some unwanted changes, tidy some names
  • Remove unused class EvtDecayParm
  • Reapply clang-format
  • Few additional tidy ups
  • Add pre-build checks to CI
  • Fix formatting
  • More formatting fixes after rebasing
  • Few missed renames
  • More formatting fixes
tlatham retitled this revision from Started to rename member variables to avoid leading underscores to Rename member variables to follow convention of `m_` prefix.Sep 23 2022, 5:15 PM
tlatham edited the summary of this revision. (Show Details)
tlatham edited the test plan for this revision. (Show Details)
tlatham retitled this revision from Rename member variables to follow convention of `m_` prefix to Rename member variables to follow convention of m_ prefix.