Opened 4 years ago

Last modified 4 years ago

#1654 confirmed enhancement

All accessible Cactus flesh functions should either be documented or deprecated

Reported by: Ian Hinder Owned by:
Priority: optional Milestone:
Component: Cactus Version: development version
Keywords: Cc:


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.

Attachments (0)

Change History (2)

comment:1 Changed 4 years ago by Steven R. Brandt

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

comment:2 Changed 4 years ago by Ian Hinder

Status: newconfirmed

Modify Ticket

Change Properties
Set your email in Preferences
as confirmed The ticket will remain with no owner.
Next status will be 'review'.
as The resolution will be set.
to The owner will be changed from (none) to the specified user.
The owner will be changed from (none) to anonymous.

Add Comment

E-mail address and name can be saved in the Preferences.

Note: See TracTickets for help on using tickets.