ecp-veloc / component-dev-docs Goto Github PK

Currently, the way tests are set up for some of the components, adding a test requires the number of nodes be dictated:

ADD_TEST(NAME shuffile_test COMMAND ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} 6 -N3 -m block ./shuffile_test)
                                                                         ^^^

This causes the tests to fail as -N is not recognized.

This is currently an issue with:

• shuffile
• redset

I've set up a repo for the user documentation which uses Doxygen to parse the header files and generate documentation. It requires that the header files be documented in a specific way. I need to write this down so that future developers can follow.

The components should have a common release process. We should document:

• how to name a release / tag
• what should be included in the release notes
• when to do a release