Skip to content

pdn: adjust naming to Google-style (excluding method names)#10192

Merged
maliberty merged 1 commit into
The-OpenROAD-Project:masterfrom
The-OpenROAD-Project-staging:pdn-tidy-naming
Apr 19, 2026
Merged

pdn: adjust naming to Google-style (excluding method names)#10192
maliberty merged 1 commit into
The-OpenROAD-Project:masterfrom
The-OpenROAD-Project-staging:pdn-tidy-naming

Conversation

@openroad-ci

Copy link
Copy Markdown
Member

Summary

adjust naming to Google-style (excluding method names)

Type of Change

  • Refactoring

Impact

None

Verification

  • I have verified that the local build succeeds (./etc/Build.sh).
  • I have run the relevant tests and they pass.
  • My code follows the repository's formatting guidelines.
  • I have signed my commits (DCO).

Signed-off-by: Matt Liberty <mliberty@precisioninno.com>
@maliberty maliberty enabled auto-merge April 19, 2026 22:41

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request performs an extensive refactoring of the PDN generation module to standardize naming conventions across the codebase. The changes primarily involve renaming enumeration members and static constants to use the kPascalCase prefix, as well as converting function parameters and local variables from camelCase to snake_case. The review feedback suggests further aligning with C++ style guidelines by using pointers instead of references for output parameters in the findRingShapes function.

Comment thread src/pdn/src/sroute.cpp
Comment on lines +32 to +33
std::vector<odb::dbSBox*> SRoute::findRingShapes(odb::dbNet* net,
uint32_t& h_dy)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

According to the Google C++ Style Guide, output parameters should be passed by pointer rather than by reference. This makes it explicit at the call site that the variable may be modified.

Suggested change
std::vector<odb::dbSBox*> SRoute::findRingShapes(odb::dbNet* net,
uint32_t& h_dy)
std::vector<odb::dbSBox*> SRoute::findRingShapes(odb::dbNet* net,
uint32_t* h_dy)
References
  1. Function parameters should be passed by value or by const reference. Use pointers for output parameters. (link)

Comment thread src/pdn/src/sroute.h
const char* iterm_name,
const std::vector<odb::dbSBox*>& ring);
std::vector<odb::dbSBox*> findRingShapes(odb::dbNet* net, uint32_t& Hdy);
std::vector<odb::dbSBox*> findRingShapes(odb::dbNet* net, uint32_t& h_dy);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

As noted in the implementation, output parameters should be passed by pointer to adhere to the Google C++ Style Guide.

Suggested change
std::vector<odb::dbSBox*> findRingShapes(odb::dbNet* net, uint32_t& h_dy);
std::vector<odb::dbSBox*> findRingShapes(odb::dbNet* net, uint32_t* h_dy);
References
  1. Function parameters should be passed by value or by const reference. Use pointers for output parameters. (link)

@github-actions

Copy link
Copy Markdown
Contributor

clang-tidy review says "All clean, LGTM! 👍"

@maliberty maliberty merged commit 1c67315 into The-OpenROAD-Project:master Apr 19, 2026
17 checks passed
@maliberty maliberty deleted the pdn-tidy-naming branch April 19, 2026 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants