summaryrefslogtreecommitdiff
path: root/source3/lib/replace/README
diff options
context:
space:
mode:
authorStefan Metzmacher <metze@samba.org>2006-09-18 22:49:20 +0000
committerGerald (Jerry) Carter <jerry@samba.org>2007-10-10 11:52:03 -0500
commit8f153c6128dd15fb132d8ddb1752e793bd6a5985 (patch)
tree0e2314019948ef0fdfcce1a15a63c0a4828e6bb7 /source3/lib/replace/README
parentf2e7b8d1449b9f8a7177a19842d25440950f733f (diff)
downloadsamba-8f153c6128dd15fb132d8ddb1752e793bd6a5985.tar.gz
samba-8f153c6128dd15fb132d8ddb1752e793bd6a5985.tar.bz2
samba-8f153c6128dd15fb132d8ddb1752e793bd6a5985.zip
r18644: bring in libreplace in lib/replace
metze (This used to be commit 596cbe73dd268742acf456fccd8a234376fb0c97)
Diffstat (limited to 'source3/lib/replace/README')
-rw-r--r--source3/lib/replace/README80
1 files changed, 80 insertions, 0 deletions
diff --git a/source3/lib/replace/README b/source3/lib/replace/README
new file mode 100644
index 0000000000..fd630ddc45
--- /dev/null
+++ b/source3/lib/replace/README
@@ -0,0 +1,80 @@
+This subsystem ensures that we can always use a certain core set of
+functions and types, that are either provided by the OS or by replacement
+functions / definitions in this subsystem. The aim is to try to stick
+to POSIX functions in here as much as possible. Convenience functions
+that are available on no platform at all belong in other subsystems
+(such as LIBUTIL).
+
+The following functions are guaranteed:
+
+ftruncate
+strlcpy
+strlcat
+mktime
+rename
+innetgr
+initgroups
+memmove
+strdup
+inet_ntoa
+setlinebuf
+vsyslog
+timegm
+setenv
+strndup
+strnlen
+waitpid
+seteuid
+setegid
+asprintf
+snprintf
+vasprintf
+vsnprintf
+opendir
+readdir
+telldir
+seekdir
+closedir
+dlopen
+dlclose
+dlsym
+dlerror
+chroot
+bzero
+strerror
+errno
+mkdtemp
+mkstemp (a secure one!)
+pread
+pwrite
+getpass
+readline (the library)
+inet_ntoa
+strtoll
+strtoull
+
+Types:
+bool
+socklen_t
+uint_t
+uint{8,16,32,64}_t
+int{8,16,32,64}_t
+intptr_t
+
+Constants:
+PATH_NAME_MAX
+UINT{16,32,64}_MAX
+INT32_MAX
+
+Macros:
+va_copy
+__FUNCTION__
+__STRING
+MIN
+MAX
+
+Prerequisites:
+memset (for bzero)
+syslog (for vsyslog)
+setnetgrent, getnetgrent, endnetgrent (for innetgr)
+mktemp (for mkstemp and mkdtemp)