Document which headers should be used when declaring functions static to the library, and functions destined for the private utility library.
Signed-off-by: Andy Whitcroft <[EMAIL PROTECTED]> --- hugetlbfs.h | 7 +++++++ libhugetlbfs_internal.h | 11 +++++++++++ libhugetlbfs_privutils.h | 13 +++++++++++++ 3 files changed, 31 insertions(+), 0 deletions(-) diff --git a/hugetlbfs.h b/hugetlbfs.h index 6b64ee7..0694a0b 100644 --- a/hugetlbfs.h +++ b/hugetlbfs.h @@ -16,6 +16,13 @@ * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ + +/* + * This file should only contain definitions of functions, data types, and + * constants which are part of the published libhugetlfs API. Functions + * exported here must also be listed in version.lds. + */ + #ifndef _HUGETLBFS_H #define _HUGETLBFS_H diff --git a/libhugetlbfs_internal.h b/libhugetlbfs_internal.h index 8d745eb..2fce2dc 100644 --- a/libhugetlbfs_internal.h +++ b/libhugetlbfs_internal.h @@ -16,6 +16,17 @@ * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ + +/* + * This file should only contain definitions of functions, data types, and + * constants which are used internally within the libhugetlbfs library. + * + * All external functions declared here are library static and must be + * internalised using a define of the following form: + * + * #define foo __lh_foo + */ + #ifndef _LIBHUGETLBFS_INTERNAL_H #define _LIBHUGETLBFS_INTERNAL_H diff --git a/libhugetlbfs_privutils.h b/libhugetlbfs_privutils.h index 1f4aae3..008955e 100644 --- a/libhugetlbfs_privutils.h +++ b/libhugetlbfs_privutils.h @@ -16,6 +16,19 @@ * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ + +/* + * This file should only contain definitions of functions, data types, and + * constants which are part of the internal private utilities interfaces. + * These are exposed only to utilities and tests within the source, this is + * not a public interface nor part of the libhugetlfs API. + * + * All functions declared external here must be externalised using a define + * of the following form: + * + * #define foo __pu_foo + */ + #ifndef _LIBHUGETLBFS_PRIVUTILS_H #define _LIBHUGETLBFS_PRIVUTILS_H -- 1.6.0.2.711.gf1ba4 ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Libhugetlbfs-devel mailing list Libhugetlbfs-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/libhugetlbfs-devel
