This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: [PATCH v12 5/6] Documentation to the above changes (bug 10871).
On 01/20/2018 12:36 AM, Rical Jasan wrote:
> On 01/15/2018 03:46 AM, Rafal Luzynski wrote:
>> Can I suggest that if there are no issues beyond the documentation
>> (yes, I know that whether we add _NL_ABALTMON_* or __ABALTMON_* and
>> ABALTMON_* is a serious API issue) then please let's commit this ASAP
>> to make sure we have those remaining 2 weeks to announce the change
>> to the outer world and let's polish the documentation within this
>> period?
> Here's a patch with my suggestions for the documentation; it should
> apply on top of yours if you'd like to merge it in (or I can push it
> later; I don't have a strong opinion).
>
> I mention that an ABALTMON equivalent for %Ob isn't provided, but is
> expected, and that _NL_ABALTMON may be used in the meantime. I'm not
> sure if we want to say it quite that way, but it's a start.
>
> That was my mistake about "@:" being a colon. That's what I get for
> reviewing with the Texinfo manual out of hand. :) I think Texinfo
> handles the comma after the period properly, as I couldn't tell a
> difference in the rendered output either way, but it doesn't hurt to
> give it hints, so I left it in. I did add commas before "etc." though.
>
> I agree that if it's documentation minutiae holding this up, the patches
> should go in.
This looks good to me.
Reviewed-by: Carlos O'Donell <carlos@redhat.com>
> diff --git a/manual/locale.texi b/manual/locale.texi
> index 059db75c1c..19b1cfc421 100644
> --- a/manual/locale.texi
> +++ b/manual/locale.texi
> @@ -923,7 +923,7 @@ corresponds to Sunday.
> @itemx DAY_5
> @itemx DAY_6
> @itemx DAY_7
> -Similar to @code{ABDAY_1} etc.,@: but here the return value is the
> +Similar to @code{ABDAY_1}, etc.,@: but here the return value is the
> unabbreviated weekday name.
> @item ABMON_1
> @itemx ABMON_2
> @@ -952,7 +952,7 @@ corresponds to January.
> @itemx MON_10
> @itemx MON_11
> @itemx MON_12
> -Similar to @code{ABMON_1} etc.,@: but here the month names are not abbreviated.
> +Similar to @code{ABMON_1}, etc.,@: but here the month names are not abbreviated.
> Here the first value @code{MON_1} also corresponds to January.
> @item ALTMON_1
> @itemx ALTMON_2
> @@ -966,13 +966,19 @@ Here the first value @code{MON_1} also corresponds to January.
> @itemx ALTMON_10
> @itemx ALTMON_11
> @itemx ALTMON_12
> -Similar to @code{MON_1} etc.,@: but here the month names are in the grammatical
> +Similar to @code{MON_1}, etc.,@: but here the month names are in the grammatical
> form used when the month is named by itself. The @code{strftime} functions
> -use these month names for the format specifier @code{OB}.
> +use these month names for the conversion specifier @code{%OB}
> +(@pxref{Formatting Calendar Time}).
>
> Note that not all languages need two different forms of the month names,
> so the strings returned for @code{MON_@dots{}} and @code{ALTMON_@dots{}}
> may or may not be the same, depending on the locale.
> +
> +@strong{NB:} @code{ABALTMON_@dots{}} constants corresponding to the @code{%Ob}
> +conversion specifier are not currently provided, but are expected to be in a
> +future release. In the meantime, it is possible to use
> +@code{_NL_ABALTMON_@dots{}}.
> @item AM_STR
> @itemx PM_STR
> The return values are strings which can be used in the representation of time
> diff --git a/manual/time.texi b/manual/time.texi
> index 2a5afd9e56..6c3d5e9ab2 100644
> --- a/manual/time.texi
> +++ b/manual/time.texi
> @@ -1349,7 +1349,7 @@ Emperors' reigns.
> With all format specifiers that produce numbers: use the locale's
> alternate numeric symbols.
>
> -With @code{%B} and @code{%b}: use the grammatical form for month names
> +With @code{%B}, @code{%b}, and @code{%h}: use the grammatical form for month names
> that is appropriate when the month is named by itself, rather than
> the form that is appropriate when the month is used as part of a
> complete date. This is a GNU extension.
--
Cheers,
Carlos.