summaryrefslogtreecommitdiff
path: root/libiberty/bcmp.c
diff options
context:
space:
mode:
authorDJ Delorie <dj@redhat.com>2001-09-26 14:16:17 -0400
committerDJ Delorie <dj@gcc.gnu.org>2001-09-26 14:16:17 -0400
commitaaa5f039eb95c50ee9dfb8b810f5b1d607cabeee (patch)
tree3731ea290c206f61394a41a0ef3959828587369f /libiberty/bcmp.c
parentb8af0ca5c72a8663b3ea7b0d706cb7055d827aed (diff)
configure.in (MAKEINFO, PERL): Detect these.
* configure.in (MAKEINFO, PERL): Detect these. (--enable-maintainer-mode): Add. * configure: Regenerate. * Makefile.in (MAKEINFO, PERL): Define. (libiberty.info, libiberty.dvi, libiberty.html): New. (CFILES): Add bsearch.c. (CONFIGURED_OFILES): New, list of objects configure might add. (maint-missing, maint-buildall): New, for maintainers only. (clean, mostlyclean): Add info/dvi/html files. * libiberty.texi, copying-lib.texi, obstacks.texi, functions.texi: New. * gather-docs: New, for maintainers. * maint-tool: New, for maintainers. * alloca.c, atexit.c, basename.c, bcmp.c, bcopy.c, bsearch.c, bzero.c, calloc.c, clock.c, configure.in, configure, getcwd.c, getpagesize.c, getpwd.c, index.c, memchr.c, memcmp.c, memcpy.c, memmove.c, memset.c, putenv.c, rename.c, rindex.c, setenv.c, sigsetmask.c, strcasecmp.c, strchr.c, strdup.c, strerror.c, strncasecmp.c, strncmp.c, strrchr.c, strstr.c, strtod.c, strtol.c, tmpnam.c, vfork.c, vprintf.c, waitpid.c, xatexit.c, xexit.c, xmalloc.c, xmemdup.c, xstrdup.c, xstrerror.c: Add or update documentation. Co-Authored-By: Phil Edwards <pedwards@disaster.jaj.com> From-SVN: r45828
Diffstat (limited to 'libiberty/bcmp.c')
-rw-r--r--libiberty/bcmp.c27
1 files changed, 7 insertions, 20 deletions
diff --git a/libiberty/bcmp.c b/libiberty/bcmp.c
index 11e4417db15..71bb7ae8ffd 100644
--- a/libiberty/bcmp.c
+++ b/libiberty/bcmp.c
@@ -3,28 +3,15 @@
/*
-NAME
+@deftypefn Supplemental int bcmp (char *@var{x}, char *@var{y}, int @var{count})
- bcmp -- compare two memory regions
+Compares the first @var{count} bytes of two areas of memory. Returns
+zero if they are the same, non-zero otherwise. Returns zero if
+@var{count} is zero. A non-zero result only indicates a difference,
+it does not indicate any sorting order (say, by having a positive
+result mean @var{x} sorts before @var{y}).
-SYNOPSIS
-
- int bcmp (char *from, char *to, int count)
-
-DESCRIPTION
-
- Compare two memory regions and return zero if they are identical,
- non-zero otherwise. If count is zero, return zero.
-
-NOTES
-
- No guarantee is made about the non-zero returned value. In
- particular, the results may be signficantly different than
- strcmp(), where the return value is guaranteed to be less than,
- equal to, or greater than zero, according to lexicographical
- sorting of the compared regions.
-
-BUGS
+@end deftypefn
*/