xsdk-project / xsdk-community-policies Goto Github PK

The list of packages in the README are not up to date. It would be worth checking through the wording at the same time.

For our milestone on documenting the community policies we should take a look at them and see where editorial changes or more are needed.

Here are a few issues I noticed:

• M5 ends with the following sentences:
  The IDEAS project will not provide a go-between for users of xSDK packages and xSDK member packages. The xSDK strategy is to make sure that the xSDK functionality fits naturally into existing library support models.
  The first sentence does no longer make sense and should be deleted.
  I am not really sure how the last sentence fits here. We should discuss this.

• *M13 contains the following sentence:
  In addition, the libraries and header files should not have the version number embedded in them ...
  It is not completely clear what is meant by them'. I suggest to replace them' with `the names'.

While looking into the XSDK requirements I found that the "installation policies" link in the M1 package policies document needs updating to this page I believe.

Discuss whether packages should be required to invoke smoke testing via Spack.

Reference: The previous installation policy 12 stated:

12. After packages are configured, they can be compiled, installed and "smoke" tested with the following commands: `make ;

[sudo] make install ; make test_install`.

There is a run_tests option in Spack which can be invoked:

spack install --run-tests

The package support for this option is described in the Spack docs

As stated in the docs, a test function should be created with the special decorators. Some packages implement this, with different function names, some using the decorators and some just accessing self.run_tests such as hypre and petsc.

For packages that use the decorators, some use @run_after('build') as in the docs, some using @run_after('install') such as hdf5.

We should also discuss how this would work with the metapackage.

To distinguish RelwithDebInfo and Debug.

In refence to xSDK spack variant guidelines

Agree/Establish what cmake does here.

For discussion.

There is no git tag for v0.5.0 of the policies. We should locate the appropriate commit and tag it.

Should there be a new recommended policy asking library authors to duplicate passed in communicators for the use in a library? This would abstract the library's communication context from the user's.