Deprecate external use of libio.h and _G_config.h.
commit48a8f8328122ab8d06b7333cb87be46feeaf7cca
authorZack Weinberg <zackw@panix.com>
Sat, 23 Dec 2017 05:06:03 +0000 (23 00:06 -0500)
committerZack Weinberg <zackw@panix.com>
Sun, 24 Dec 2017 17:03:28 +0000 (24 09:03 -0800)
treee61a3b567c0c78787c06a38dfe0fce7ccb749f28
parenta47ad79afa454192224214a3db2499de12baf93e
Deprecate external use of libio.h and _G_config.h.

libio.h was originally the header for a set of supported GNU
extensions, but they have not been maintained as such in many years,
they are now standing in the way of improvements to stdio, and we
don't think there are any remaining external users.  _G_config.h was
never intended for public use, but predates the bits convention.
Move both of these headers into the bits directory and provide stubs
at top level which issue deprecation warnings.

The contents of (bits/)libio.h and (bits/)_G_config.h are still
exposed to external software via stdio.h; changing that requires more
complex surgery than I have time to attempt right now.

* libio/libio.h, libio/_G_config.h: New stub headers which issue a
deprecation warning and then include <bits/libio.h>, <bits/_G_config.h>
respectively.
* libio/libio.h: Rename the original version of this file to
libio/bits/libio.h.  Error out if not included by stdio.h or the
stub libio.h.
* include/libio.h: Move to include/bits.  Forward to libio/bits/libio.h.
* sysdeps/generic/_G_config.h: Move to top-level bits/.  Error out
if not included by bits/libio.h or the stub _G_config.h.
* sysdeps/unix/sysv/linux/_G_config.h: Move to
sysdeps/unix/sysv/linux/bits.  Error out if not included by
bits/libio.h or the stub _G_config.h.
* libio/stdio.h: Include bits/libio.h, not libio.h.
* libio/Makefile: Install bits/libio.h and bits/_G_config.h as
well as libio.h and _G_config.h.

* csu/init.c, libio/fmemopen.c, libio/iolibio.h, libio/oldfmemopen.c
* libio/strfile.h, stdio-common/vfscanf.c
* sysdeps/pthread/flockfile.c, sysdeps/pthread/funlockfile.c
Include stdio.h, not _G_config.h nor libio.h.
* libio/iofgetpos.c: Also rename fgetpos64 out of the way.
* libio/iofsetpos.c: Also rename fsetpos64 out of the way.

* scripts/check-installed-headers.sh: Skip libio.h and _G_config.h.
21 files changed:
ChangeLog
NEWS
bits/_G_config.h [moved from sysdeps/generic/_G_config.h with 84% similarity]
csu/init.c
include/bits/libio.h [moved from include/libio.h with 97% similarity]
libio/Makefile
libio/_G_config.h [copied from csu/init.c with 73% similarity]
libio/bits/libio.h [moved from libio/libio.h with 98% similarity]
libio/fmemopen.c
libio/iofgetpos.c
libio/iofsetpos.c
libio/iolibio.h
libio/libio.h [copied from csu/init.c with 73% similarity]
libio/oldfmemopen.c
libio/stdio.h
libio/strfile.h
scripts/check-installed-headers.sh
stdio-common/vfscanf.c
sysdeps/pthread/flockfile.c
sysdeps/pthread/funlockfile.c
sysdeps/unix/sysv/linux/bits/_G_config.h [moved from sysdeps/unix/sysv/linux/_G_config.h with 84% similarity]