summaryrefslogtreecommitdiff
path: root/manual/maint.texi
diff options
context:
space:
mode:
authorUlrich Drepper <drepper@redhat.com>1997-10-15 05:34:02 +0000
committerUlrich Drepper <drepper@redhat.com>1997-10-15 05:34:02 +0000
commitf2ea0f5b0d6ff2bbf261a5fd3d61f967e36f22e6 (patch)
tree9553a1d3102f18a5c73538902c851b463b70c108 /manual/maint.texi
parent1ea89a402d892b68b193e2e4390d8eb33ed686e7 (diff)
1997-10-15 06:56 Ulrich Drepper <drepper@cygnus.com> * Rules: Remove ruls to magically install <subdir>.h headers. Reported by Mark Kettenis <kettenis@phys.uva.nl>. * glibcbug.in: Fix @gnu.ai.mit.edu -> @gnu.org. * version.c: Likewise. * catgets/gencat.c: Likewise. * db2/makedb.c: Likewise. * locale/programs/locale.c: Likewise. * locale/programs/localedef.c: Likewise. * libc.map: Move _IO_list_all back to GLIBC_2.0. * elf/rtld.c: Provide name of running program to _dl_new_object. * Rules: Implement shared-only-sources. * include/libc-symbols.h: Define default_symbol_version. * libio/Makefile (shared-only-sources): Define. * libio/freopen.c: Define as default version. * libio/iofopen.c: Likewise. * libio/genops.c: Define _IO_list_all here. * libio/stdfiles.c: Create linked list with public names. * libio/oldstdfiles.c: Likewise. * stdio-common/printf.c: Optimize. * stdio-common/scanf.c: Optimize. * sysdeps/generic/setfpucw.c: Include #include <...> not "...". * sysdeps/i386/i486/bits/string.h: Add optimized versions of index and rindex. 1997-10-14 Andreas Jaeger <aj@arthur.rhein-neckar.de> * manual/arith.texi: Spelling fixes. * manual/conf.texi: Likewise. * manual/creature.texi: Likewise. * manual/filesys.texi: Likewise. * manual/intro.texi: Likewise. * manual/llio.texi: Likewise. * manual/math.texi: Likewise. * manual/message.texi: Likewise. * manual/pattern.texi: Likewise. * manual/search.texi: Likewise. * manual/signal.texi: Likewise. * manual/socket.texi: Likewise. * manual/startup.texi: Likewise. * manual/stdio.texi: Likewise. * manual/string.texi: Likewise. * manual/time.texi: Likewise. * manual/users.texi: Likewise. 1997-10-13 05:25 Ulrich Drepper <drepper@cygnus.com> * sysdeps/generic/sys/mman.h: Use __ptr_t instead of __caddr_t. * sysdeps/unix/bsd/osf/sys/mman.h: Likewise. * sysdeps/unix/bsd/sun/sunos4/sys/mman.h: Likewise. * sysdeps/unix/bsd/ultrix4/sys/mman.h: Likewise. * sysdeps/unix/sysv/irix4/sys/mman.h: Likewise. * sysdeps/unix/sysv/linux/sys/mman.h: Likewise. * sysdeps/mach/hurd/mmap.c: Likewise. * sysdeps/generic/mmap.c: Likewise. * sysdeps/unix/bsd/sun/sunos4/mmap.c: Likewise. * sysdeps/mach/munmap.c: Likewise. * sysdeps/generic/munmap.c: Likewise. * sysdeps/mach/mprotect.c: Likewise. * sysdeps/generic/mprotect.c: Likewise. * sysdeps/generic/msync.c: Likewise. * sysdeps/generic/madvise.c: Likewise. * sysdeps/unix/sysv/linux/madvise.c: Include stub version from generic subdir. 1997-10-12 20:27 Zack Weinberg <zack@rabi.phys.columbia.edu> * sysdeps/stub (all files): Moved to sysdeps/generic. * all files using stub_warning: Include <stub-tag.h>. * include/stub-tag.h: New file, marks stubs in .d files. * Makerules: Look for stub-tag.h, not sysdeps/stub, when building <gnu/stubs.h>. * configure.in: Don't add sysdeps/stub to $sysnames. * sysdeps/unix/Makefile: Look for generic headers, not stub headers. * sysdeps/generic/Makefile: Likewise. * manual/maint.texi: Delete references to sysdeps/stub. * INSTALL: Rebuilt. * configure: Rebuilt.
Diffstat (limited to 'manual/maint.texi')
-rw-r--r--manual/maint.texi51
1 files changed, 30 insertions, 21 deletions
diff --git a/manual/maint.texi b/manual/maint.texi
index e6fc47f8e1..7698549bf3 100644
--- a/manual/maint.texi
+++ b/manual/maint.texi
@@ -513,25 +513,35 @@ posix
@noindent
So the final list is @file{unix/bsd/vax unix/bsd unix/inet unix posix}.
-@file{sysdeps} has two ``special'' subdirectories, called @file{generic}
-and @file{stub}. These two are always implicitly appended to the list
-of subdirectories (in that order), so you needn't put them in an
-@file{Implies} file, and you should not create any subdirectories under
-them intended to be new specific categories. @file{generic} is for
-things that can be implemented in machine-independent C, using only
-other machine-independent functions in the C library. @file{stub} is
-for @dfn{stub} versions of functions which cannot be implemented on a
-particular machine or operating system. The stub functions always
-return an error, and set @code{errno} to @code{ENOSYS} (Function not
-implemented). @xref{Error Reporting}.
-
-A source file is known to be system-dependent by its having a version in
-@file{generic} or @file{stub}; every generally-available function whose
-implementation is system-dependent in should have either a generic or
-stub implementation (there is no point in having both). Some rare functions
-are only useful on specific systems and aren't defined at all on others;
-these do not appear anywhere in the system-independent source code or makefiles
-(including the @file{generic} and @file{stub} directories), only in the
+@file{sysdeps} has a ``special'' subdirectory called @file{generic}. It
+is always implicitly appended to the list of subdirectories, so you
+needn't put it in an @file{Implies} file, and you should not create any
+subdirectories under it intended to be new specific categories.
+@file{generic} serves two purposes. First, the makefiles do not bother
+to look for a system-dependent version of a file that's not in
+@file{generic}. This means that any system-dependent source file must
+have an analogue in @file{generic}, even if the routines defined by that
+file are not implemented on other platforms. Second. the @file{generic}
+version of a system-dependent file is used if the makefiles do not find
+a version specific to the system you're compiling for.
+
+If it is possible to implement the routines in a @file{generic} file in
+machine-independent C, using only other machine-independent functions in
+the C library, then you should do so. Otherwise, make them stubs. A
+@dfn{stub} function is a function which cannot be implemented on a
+particular machine or operating system. Stub functions always return an
+error, and set @code{errno} to @code{ENOSYS} (Function not implemented).
+@xref{Error Reporting}. If you define a stub function, you must place
+the statement @code{stub_warning(@var{function})}, where @var{function}
+is the name of your function, after its definition; also, you must
+include the file @code{<stub-tag.h>} into your file. This causes the
+function to be listed in the installed @code{<gnu/stubs.h>}, and
+makes GNU ld warn when the function is used.
+
+Some rare functions are only useful on specific systems and aren't
+defined at all on others; these do not appear anywhere in the
+system-independent source code or makefiles (including the
+@file{generic} and @file{stub} directories), only in the
system-dependent @file{Makefile} in the specific system's subdirectory.
If you come across a file that is in one of the main source directories
@@ -737,8 +747,7 @@ hierarchy that are not for particular machine architectures.
@table @file
@item generic
-@itemx stub
-As described above (@pxref{Porting}), these are the two subdirectories
+As described above (@pxref{Porting}), this is the subdirectory
that every configuration implicitly uses after all others.
@item ieee754