public inbox for libc-alpha@sourceware.org
 help / color / mirror / Atom feed
* [PATCH] manual: Update _TIME_BITS to clarify it's user defined
@ 2021-10-14 21:55 Stafford Horne
  2021-10-18 16:30 ` Adhemerval Zanella
  0 siblings, 1 reply; 2+ messages in thread
From: Stafford Horne @ 2021-10-14 21:55 UTC (permalink / raw)
  To: GLIBC patches

The current language reads "This macro determines...", changing to
"Define this macro...".  This is consistent with other feature macro
documentation language.

When I first read the previous language it seems to indicate that the
macro is already defined.  By changing the language to "Define this
macro..." it's clear that its the user's responsibility to define it.
---
 manual/creature.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/manual/creature.texi b/manual/creature.texi
index c13de52f1f..6193e0735c 100644
--- a/manual/creature.texi
+++ b/manual/creature.texi
@@ -171,8 +171,8 @@ This macro was introduced as part of the Large File Support extension
 @end defvr
 
 @defvr Macro _TIME_BITS
-This macro determines the bit size of @code{time_t}, and therefore the
-bit size of all @code{time_t}-derived types and the prototypes of all
+Define this macro to control the bit size of @code{time_t}, and therefore
+the bit size of all @code{time_t}-derived types and the prototypes of all
 related functions.
 
 @enumerate
-- 
2.31.1


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] manual: Update _TIME_BITS to clarify it's user defined
  2021-10-14 21:55 [PATCH] manual: Update _TIME_BITS to clarify it's user defined Stafford Horne
@ 2021-10-18 16:30 ` Adhemerval Zanella
  0 siblings, 0 replies; 2+ messages in thread
From: Adhemerval Zanella @ 2021-10-18 16:30 UTC (permalink / raw)
  To: Stafford Horne, GLIBC patches



On 14/10/2021 18:55, Stafford Horne via Libc-alpha wrote:
> The current language reads "This macro determines...", changing to
> "Define this macro...".  This is consistent with other feature macro
> documentation language.
> 
> When I first read the previous language it seems to indicate that the
> macro is already defined.  By changing the language to "Define this
> macro..." it's clear that its the user's responsibility to define it.

LGTM, thanks.

Reviewed-by: Adhemerval Zanella <adhemerval.zanella@linaro.org>

> ---
>  manual/creature.texi | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/manual/creature.texi b/manual/creature.texi
> index c13de52f1f..6193e0735c 100644
> --- a/manual/creature.texi
> +++ b/manual/creature.texi
> @@ -171,8 +171,8 @@ This macro was introduced as part of the Large File Support extension
>  @end defvr
>  
>  @defvr Macro _TIME_BITS
> -This macro determines the bit size of @code{time_t}, and therefore the
> -bit size of all @code{time_t}-derived types and the prototypes of all
> +Define this macro to control the bit size of @code{time_t}, and therefore
> +the bit size of all @code{time_t}-derived types and the prototypes of all
>  related functions.
>  
>  @enumerate
> 

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-10-18 16:30 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-10-14 21:55 [PATCH] manual: Update _TIME_BITS to clarify it's user defined Stafford Horne
2021-10-18 16:30 ` Adhemerval Zanella

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).