Maintaining Database

NOTE: Be sure to follow thoroughly with OOVPA signature guideline.

Add new founding symbol(s) or variant of symbol ABI

1. Add xref name in a xxxx.def file from include/xref/ directory.
2. Create OOVPA signature in src/OOVPADatabase/XXX/####.inl file respectfully.
3. Add OOVPA register into src/OOVPADatabase/XXX_OOVPA.inl file.
4. Add xref register into src/test/libverify/XXX.cpp file.
5. Go to Before Create Pull Request step.

If none of above are done correctly, then pull request creation will report failures.

Add detection to existing symbol

1. Create OOVPA signature in src/OOVPADatabase/XXX/####.inl file respectfully.
2. Append OOVPA register into src/OOVPADatabase/XXX_OOVPA.inl file.
3. Update xref register into src/test/libverify/XXX.cpp file if necessary.
4. Go to Before Create Pull Request step.

Before Create Pull Request

1. Run unit test tool to verify implementation is working as intended.
   • NOTE: XbSymbolDatabaseUnitTest provide ability to recognize if new symbols are detected. Assuming you have perform previous test stored into cache. Otherwise, you can also look into cache folder to search for specific symbols.
2. Verify codebase are clang-formatted and saved into commit.
3. Make sure OOVPA signature guideline has been followed thoroughly.
4. Finally, create pull request to integrate either existing or new symbols into XbSymbolDatabase.

If none of above are done correctly, then pull request creation will report failures.