Function naming
Interface functions and global variables in PVFS should use a standard
naming convention for clarity. Here are a few guidelines:
- The letters ``PVFS'' should only be prepended to functions and
global variables that exist as part of an application level interface.
Some examples would be PVFS_open and PVFS_read. For
clarity, do not use this naming scheme for interfaces internal to PVFS.
- Well defined internal PVFS interfaces should use the prefix
``PINT'' (this is short for ``PVFS interface''). This should then be
followed by an identifier for the interface, and then a description of
what the particular function does. Some examples are PINT_flow_alloc, PINT_flow_free, and PINT_flow_post.
- There are exceptions to the above rule. For example, well defined
interfaces that exist within a very distinct module of PVFS may use a
different prefix. Examples include the method functions within the BMI
layer of PVFS communications have names such as METH_tcp_send
and METH_tcp_recv.
- Any variables that are globally visible should follow the rules
listed above as well. This naming convention is for both functions and
global variables.