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

Standardize Include Guards #1653

Merged
merged 4 commits into from May 10, 2019

Conversation

@KaustubhShamshery
Copy link
Collaborator

commented May 9, 2019

Description

Standardize header guards.

Reference : https://google.github.io/styleguide/cppguide.html#The__define_Guard

  • For our case, it is ZILLIQA_<path_to_file>_H_

  • to generate header guard put,

#ifndef A_H_ 
#define A_H_
....
.... 
#endif  // A_H_

and run ./scripts/replace_header_guard.py and the statements will be replaced by correct header guard

Backward Compatibility

  • This is not a breaking change
  • This is a breaking change

Review Suggestion

Status

Implementation

  • Check License
  • ready for review

Integration Test (Core Team)

  • local machine test
  • small-scale cloud test
@KaustubhShamshery KaustubhShamshery requested review from Gnnng, ansnunez and ckyang May 9, 2019
@KaustubhShamshery KaustubhShamshery changed the title Standardize DS Guards Standardize Include Guards May 9, 2019
@codecov-io

This comment has been minimized.

Copy link

commented May 9, 2019

Codecov Report

Merging #1653 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1653   +/-   ##
=======================================
  Coverage   33.53%   33.53%           
=======================================
  Files         269      269           
  Lines       32757    32757           
=======================================
  Hits        10984    10984           
  Misses      21773    21773
Impacted Files Coverage Δ
src/libConsensus/ConsensusLeader.h 0% <ø> (ø) ⬆️
src/libDirectoryService/DirectoryService.h 0% <ø> (ø) ⬆️
src/libData/BlockData/BlockHeader/DSBlockHeader.h 6.25% <ø> (ø) ⬆️
src/libUtils/TimeLockedFunction.h 100% <ø> (ø) ⬆️
src/libData/BlockData/Block/VCBlock.h 20% <ø> (ø) ⬆️
src/libUtils/IPConverter.h 100% <ø> (ø) ⬆️
src/libUtils/DataConversion.h 71.87% <ø> (ø) ⬆️
src/libData/BlockData/BlockHeader/TxBlockHeader.h 7.14% <ø> (ø) ⬆️
src/libData/AccountData/TxnPool.h 2.73% <ø> (ø) ⬆️
src/libServer/Server.h 0% <ø> (ø) ⬆️
... and 64 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 474fd5c...fb0651a. Read the comment docs.

@KaustubhShamshery KaustubhShamshery force-pushed the feature/include_guard_check branch 3 times, most recently from b6daec3 to 77107a0 May 9, 2019
@KaustubhShamshery KaustubhShamshery force-pushed the feature/include_guard_check branch from ed7c2b0 to 648c434 May 9, 2019
@KaustubhShamshery KaustubhShamshery self-assigned this May 10, 2019
@KaustubhShamshery KaustubhShamshery added this to PRs in development in Core via automation May 10, 2019
@ansnunez ansnunez moved this from PRs in development to PRs needing review (please help!) in Core May 10, 2019
Core automation moved this from PRs needing review (please help!) to PRs approved - ready to merge! May 10, 2019
@ansnunez ansnunez merged commit e4081c4 into master May 10, 2019
2 checks passed
2 checks passed
Travis CI - Branch Build Passed
Details
Travis CI - Pull Request Build Passed
Details
Core automation moved this from PRs approved - ready to merge! to PRs done (merged) May 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Core
  
PRs done (merged)
4 participants
You can’t perform that action at this time.