All accessible Cactus flesh functions should either be documented or deprecated

Create issue
Issue #1654 open
Ian Hinder created an issue

There are some Cactus flesh functions which are not documented, and it is unclear the extent to which these are supported. The following command is one way to see the symbols provided to an executable by the Cactus flesh (there might be better or more accurate ways of doing this):

find configs/sim/build/Cactus -name "*.o"|xargs nm -g | grep -v ' U '|less

After removing CCTKi symbols etc, this list of symbols should be cross-referenced with the documentation and a decision should be made for any undocumented functions.

This is also a good way to find out about symbols which have been declared in the global namespace unintentionally.

One could also imagine having a text file with a list of all the supported function symbols, and the automated test system checking that no additional functions are exported into the global namespace.

This is not a high priority, but since I thought of it, I made the ticket anyway.

Keyword:

Comments (2)

  1. Steven R. Brandt
    • removed comment

    There are other features that are undefined that aren't symbols. The "BEGIN MESSAGE" / "END MESSAGE" directives in configure scripts for example.

  2. Log in to comment