about summary refs log tree commit diff
path: root/libio/_G_config.h
diff options
context:
space:
mode:
authorZack Weinberg <zackw@panix.com>2017-12-23 00:06:03 -0500
committerZack Weinberg <zackw@panix.com>2017-12-24 09:03:28 -0800
commit48a8f8328122ab8d06b7333cb87be46feeaf7cca (patch)
treee61a3b567c0c78787c06a38dfe0fce7ccb749f28 /libio/_G_config.h
parenta47ad79afa454192224214a3db2499de12baf93e (diff)
downloadglibc-48a8f8328122ab8d06b7333cb87be46feeaf7cca.tar.gz
glibc-48a8f8328122ab8d06b7333cb87be46feeaf7cca.tar.xz
glibc-48a8f8328122ab8d06b7333cb87be46feeaf7cca.zip
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.
Diffstat (limited to 'libio/_G_config.h')
-rw-r--r--libio/_G_config.h25
1 files changed, 25 insertions, 0 deletions
diff --git a/libio/_G_config.h b/libio/_G_config.h
new file mode 100644
index 0000000000..a0d70f6f0c
--- /dev/null
+++ b/libio/_G_config.h
@@ -0,0 +1,25 @@
+/* Copyright (C) 2017 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
+
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
+
+   The GNU C Library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <http://www.gnu.org/licenses/>.  */
+
+#ifndef _G_CONFIG_H
+#define _G_CONFIG_H 1
+
+#warning "<_G_config.h> is deprecated; use <stdio.h> instead."
+
+#include <bits/_G_config.h>
+
+#endif