aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Whitcroft <apw@shadowen.org>2008-10-20 13:48:44 +0100
committerEric B Munson <ebmunson@us.ibm.com>2008-10-21 11:14:24 +0100
commitffb6a9eedc125825ecfe2be4cab09c706aae41db (patch)
tree9f82d3e324a05c51530e8a45d55d847b66369e73
parent05a30daac3b23b0856f968a487d8e54821ab2498 (diff)
downloadlibhugetlbfs-ffb6a9eedc125825ecfe2be4cab09c706aae41db.tar.gz
document which headers to use for library static and private utility functions
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 <apw@shadowen.org> Acked-by: Adam Litke <agl@us.ibm.com>
-rw-r--r--hugetlbfs.h7
-rw-r--r--libhugetlbfs_internal.h11
-rw-r--r--libhugetlbfs_privutils.h13
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