>From 298293b2d060deaef96ac793a926ae8826d1f5e6 Mon Sep 17 00:00:00 2001 From: Bruno Haible Date: Thu, 13 Apr 2023 23:18:19 +0200 Subject: [PATCH 1/2] Adjust comments in reminders. * lib/*.h: In the comments, mention also HAVE_*. --- ChangeLog | 5 +++++ lib/alignalloc.h | 2 +- lib/fpending.h | 3 ++- lib/freadable.h | 2 +- lib/freadahead.h | 2 +- lib/freading.h | 2 +- lib/fwritable.h | 2 +- lib/fwriting.h | 2 +- lib/gethrxtime.h | 3 ++- lib/glthread/cond.h | 2 +- lib/glthread/thread.h | 2 +- lib/localename.h | 2 +- lib/malloca.h | 2 +- lib/openat.h | 2 +- lib/priv-set.h | 3 ++- lib/readline.h | 2 +- lib/readutmp.h | 4 +++- lib/relocatable.h | 2 +- lib/stat-time.h | 2 +- lib/striconv.h | 2 +- lib/striconveh.h | 2 +- lib/term-style-control.h | 2 +- lib/xmalloca.h | 2 +- lib/xsize.h | 2 +- lib/xstriconv.h | 2 +- lib/xstriconveh.h | 2 +- 26 files changed, 35 insertions(+), 25 deletions(-) diff --git a/ChangeLog b/ChangeLog index a00ff55404..c15d67bb26 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2023-04-13 Bruno Haible + + Adjust comments in reminders. + * lib/*.h: In the comments, mention also HAVE_*. + 2023-04-13 Bruno Haible Adjust comments in reminders. diff --git a/lib/alignalloc.h b/lib/alignalloc.h index 1574e26c92..a3813db6f8 100644 --- a/lib/alignalloc.h +++ b/lib/alignalloc.h @@ -21,7 +21,7 @@ #define ALIGNALLOC_H_ /* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE, _GL_ATTRIBUTE_ALLOC_SIZE, - _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_RETURNS_NONNULL. */ + _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_RETURNS_NONNULL, HAVE_POSIX_MEMALIGN. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/fpending.h b/lib/fpending.h index 0585dcb329..1604ca0b7a 100644 --- a/lib/fpending.h +++ b/lib/fpending.h @@ -18,7 +18,8 @@ Written by Jim Meyering. */ -/* This file uses _GL_ATTRIBUTE_PURE. */ +/* This file uses _GL_ATTRIBUTE_PURE, HAVE_STDIO_EXT_H, + HAVE_DECL___FPENDING. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/freadable.h b/lib/freadable.h index c5d5d5cfb9..9a2cb3fecd 100644 --- a/lib/freadable.h +++ b/lib/freadable.h @@ -14,7 +14,7 @@ You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . */ -/* This file uses _GL_ATTRIBUTE_PURE. */ +/* This file uses _GL_ATTRIBUTE_PURE, HAVE___FREADABLE, HAVE_STDIO_EXT_H. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/freadahead.h b/lib/freadahead.h index d47026a05a..4a3275e90c 100644 --- a/lib/freadahead.h +++ b/lib/freadahead.h @@ -14,7 +14,7 @@ You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . */ -/* This file uses _GL_ATTRIBUTE_PURE. */ +/* This file uses _GL_ATTRIBUTE_PURE, HAVE___FREADAHEAD. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/freading.h b/lib/freading.h index c18ea4a292..0fe4810c3d 100644 --- a/lib/freading.h +++ b/lib/freading.h @@ -14,7 +14,7 @@ You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . */ -/* This file uses _GL_ATTRIBUTE_PURE. */ +/* This file uses _GL_ATTRIBUTE_PURE, HAVE___FREADING, HAVE_STDIO_EXT_H. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/fwritable.h b/lib/fwritable.h index d3c0b46615..84559a96a3 100644 --- a/lib/fwritable.h +++ b/lib/fwritable.h @@ -14,7 +14,7 @@ You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . */ -/* This file uses _GL_ATTRIBUTE_PURE. */ +/* This file uses _GL_ATTRIBUTE_PURE, HAVE___FWRITABLE, HAVE_STDIO_EXT_H. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/fwriting.h b/lib/fwriting.h index 28cb2c878a..c907695d19 100644 --- a/lib/fwriting.h +++ b/lib/fwriting.h @@ -14,7 +14,7 @@ You should have received a copy of the GNU Lesser General Public License along with this program. If not, see . */ -/* This file uses _GL_ATTRIBUTE_PURE. */ +/* This file uses _GL_ATTRIBUTE_PURE, HAVE___FWRITING, HAVE_STDIO_EXT_H. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/gethrxtime.h b/lib/gethrxtime.h index 3a1340b69d..573e600b14 100644 --- a/lib/gethrxtime.h +++ b/lib/gethrxtime.h @@ -20,7 +20,8 @@ #ifndef GETHRXTIME_H_ #define GETHRXTIME_H_ 1 -/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE. */ +/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE, HAVE_ARITHMETIC_HRTIME_T, + HAVE_DECL_GETHRTIME. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/glthread/cond.h b/lib/glthread/cond.h index 4c780d2def..b0d23888e2 100644 --- a/lib/glthread/cond.h +++ b/lib/glthread/cond.h @@ -48,7 +48,7 @@ #ifndef _GLTHREAD_COND_H #define _GLTHREAD_COND_H -/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE. */ +/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE, HAVE_THREADS_H. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/glthread/thread.h b/lib/glthread/thread.h index 091b601e99..88bc53ee7f 100644 --- a/lib/glthread/thread.h +++ b/lib/glthread/thread.h @@ -70,7 +70,7 @@ #ifndef _GLTHREAD_THREAD_H #define _GLTHREAD_THREAD_H -/* This file uses _Noreturn. */ +/* This file uses _Noreturn, HAVE_THREADS_H, HAVE_PTHREAD_ATFORK. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/localename.h b/lib/localename.h index f5663a6b37..c804e2d823 100644 --- a/lib/localename.h +++ b/lib/localename.h @@ -17,7 +17,7 @@ #ifndef _GL_LOCALENAME_H #define _GL_LOCALENAME_H -/* This file uses _GL_ATTRIBUTE_CONST. */ +/* This file uses _GL_ATTRIBUTE_CONST, HAVE_CFPREFERENCESCOPYAPPVALUE. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/malloca.h b/lib/malloca.h index 576a56de40..f68ddfe010 100644 --- a/lib/malloca.h +++ b/lib/malloca.h @@ -19,7 +19,7 @@ #define _MALLOCA_H /* This file uses _GL_ATTRIBUTE_ALLOC_SIZE, _GL_ATTRIBUTE_DEALLOC, - _GL_ATTRIBUTE_MALLOC. */ + _GL_ATTRIBUTE_MALLOC, HAVE_ALLOCA. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/openat.h b/lib/openat.h index ba4a780dc0..97f066d10f 100644 --- a/lib/openat.h +++ b/lib/openat.h @@ -20,7 +20,7 @@ #define _GL_HEADER_OPENAT /* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE, _Noreturn, - _GL_ATTRIBUTE_DEPRECATED. */ + _GL_ATTRIBUTE_DEPRECATED, HAVE_OPENAT. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/priv-set.h b/lib/priv-set.h index e9ffc0c9aa..c9d42b4e07 100644 --- a/lib/priv-set.h +++ b/lib/priv-set.h @@ -17,7 +17,8 @@ Written by David Bartley. */ -/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE. */ +/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE, HAVE_PRIV_H, + HAVE_GETPPRIV. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/readline.h b/lib/readline.h index 9048b727d7..416121c5c2 100644 --- a/lib/readline.h +++ b/lib/readline.h @@ -18,7 +18,7 @@ #ifndef GL_READLINE_H #define GL_READLINE_H -/* This file uses _GL_ATTRIBUTE_MALLOC. */ +/* This file uses _GL_ATTRIBUTE_MALLOC, HAVE_READLINE_READLINE_H. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/readutmp.h b/lib/readutmp.h index eda80a44fa..097dca6024 100644 --- a/lib/readutmp.h +++ b/lib/readutmp.h @@ -20,7 +20,9 @@ #ifndef __READUTMP_H__ # define __READUTMP_H__ -/* This file uses _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_RETURNS_NONNULL. */ +/* This file uses _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_RETURNS_NONNULL, + HAVE_UTMP_H, HAVE_UTMPX_H, HAVE_STRUCT_UTMP_*, HAVE_STRUCT_UTMPX_*, + HAVE_UTMPNAME, HAVE_UTMPXNAME, HAVE_DECL_GETUTENT. */ # if !_GL_CONFIG_H_INCLUDED # error "Please include config.h first." # endif diff --git a/lib/relocatable.h b/lib/relocatable.h index b29c29ed1b..f4634b1238 100644 --- a/lib/relocatable.h +++ b/lib/relocatable.h @@ -18,7 +18,7 @@ #ifndef _RELOCATABLE_H #define _RELOCATABLE_H -/* This file uses _GL_ATTRIBUTE_MALLOC. */ +/* This file uses _GL_ATTRIBUTE_MALLOC, HAVE_VISIBILITY. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/stat-time.h b/lib/stat-time.h index 487e8b0971..5b2702356e 100644 --- a/lib/stat-time.h +++ b/lib/stat-time.h @@ -21,7 +21,7 @@ #define STAT_TIME_H 1 /* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE, _GL_UNUSED, - _GL_ATTRIBUTE_PURE. */ + _GL_ATTRIBUTE_PURE, HAVE_STRUCT_STAT_*. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/striconv.h b/lib/striconv.h index 6cd7dc31cf..a4164da636 100644 --- a/lib/striconv.h +++ b/lib/striconv.h @@ -18,7 +18,7 @@ #ifndef _STRICONV_H #define _STRICONV_H -/* This file uses _GL_ATTRIBUTE_MALLOC. */ +/* This file uses _GL_ATTRIBUTE_MALLOC, HAVE_ICONV. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/striconveh.h b/lib/striconveh.h index 6bced43e9c..b109af4ea9 100644 --- a/lib/striconveh.h +++ b/lib/striconveh.h @@ -18,7 +18,7 @@ #ifndef _STRICONVEH_H #define _STRICONVEH_H -/* This file uses _GL_ATTRIBUTE_MALLOC. */ +/* This file uses _GL_ATTRIBUTE_MALLOC, HAVE_ICONV. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/term-style-control.h b/lib/term-style-control.h index 6b77277cf3..e144db944d 100644 --- a/lib/term-style-control.h +++ b/lib/term-style-control.h @@ -21,7 +21,7 @@ /* The user of this file will define a macro 'term_style_user_data', such that 'struct term_style_user_data' is a user-defined struct. */ -/* This file uses _GL_ASYNC_SAFE. */ +/* This file uses _GL_ASYNC_SAFE, HAVE_TCGETATTR. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/xmalloca.h b/lib/xmalloca.h index 3f03eba5aa..9ef41c6052 100644 --- a/lib/xmalloca.h +++ b/lib/xmalloca.h @@ -19,7 +19,7 @@ #define _XMALLOCA_H /* This file uses _GL_ATTRIBUTE_ALLOC_SIZE, _GL_ATTRIBUTE_DEALLOC, - _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_RETURNS_NONNULL. */ + _GL_ATTRIBUTE_MALLOC, _GL_ATTRIBUTE_RETURNS_NONNULL, HAVE_ALLOCA. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/xsize.h b/lib/xsize.h index 746d6569bf..5b08d61f2f 100644 --- a/lib/xsize.h +++ b/lib/xsize.h @@ -18,7 +18,7 @@ #ifndef _XSIZE_H #define _XSIZE_H -/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE. */ +/* This file uses _GL_INLINE_HEADER_BEGIN, _GL_INLINE, HAVE_STDINT_H. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/xstriconv.h b/lib/xstriconv.h index ee17e490c5..5a3a6636d3 100644 --- a/lib/xstriconv.h +++ b/lib/xstriconv.h @@ -18,7 +18,7 @@ #ifndef _XSTRICONV_H #define _XSTRICONV_H -/* This file uses _GL_ATTRIBUTE_MALLOC. */ +/* This file uses _GL_ATTRIBUTE_MALLOC, HAVE_ICONV. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif diff --git a/lib/xstriconveh.h b/lib/xstriconveh.h index fe15eed912..35ef5620f5 100644 --- a/lib/xstriconveh.h +++ b/lib/xstriconveh.h @@ -18,7 +18,7 @@ #ifndef _XSTRICONVEH_H #define _XSTRICONVEH_H -/* This file uses _GL_ATTRIBUTE_MALLOC. */ +/* This file uses _GL_ATTRIBUTE_MALLOC, HAVE_ICONV. */ #if !_GL_CONFIG_H_INCLUDED #error "Please include config.h first." #endif -- 2.34.1