[PATCH] manual: Clarify that abbreviations of long options are allowed

[PATCH] manual: Clarify that abbreviations of long options are allowed

[Siddhesh Poyarekar]

The man page and code comments clearly state that abbreviations of long
option names are recognized correctly as long as they are unique.
Document this fact in the glibc manual as well.

Signed-off-by: Siddhesh Poyarekar <siddhesh@sourceware.org>
---
 manual/getopt.texi | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/manual/getopt.texi b/manual/getopt.texi
index 5485fc4694..e58283ab88 100644
--- a/manual/getopt.texi
+++ b/manual/getopt.texi
@@ -250,7 +250,8 @@ option, and stores the option's argument (if it has one) in @code{optarg}.
 
 When @code{getopt_long} encounters a long option, it takes actions based
 on the @code{flag} and @code{val} fields of the definition of that
-option.
+option.  The option name may be abbreviated as long as the abbreviation is
+unique or is an exact match for some defined option.
 
 If @code{flag} is a null pointer, then @code{getopt_long} returns the
 contents of @code{val} to indicate which option it found.  You should
-- 
2.35.1

Re: [PATCH] manual: Clarify that abbreviations of long options are allowed

[Florian Weimer]

* Siddhesh Poyarekar via Libc-alpha:

> The man page and code comments clearly state that abbreviations of long
> option names are recognized correctly as long as they are unique.
> Document this fact in the glibc manual as well.
>
> Signed-off-by: Siddhesh Poyarekar <siddhesh@sourceware.org>
> ---
>  manual/getopt.texi | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/manual/getopt.texi b/manual/getopt.texi
> index 5485fc4694..e58283ab88 100644
> --- a/manual/getopt.texi
> +++ b/manual/getopt.texi
> @@ -250,7 +250,8 @@ option, and stores the option's argument (if it has one) in @code{optarg}.
>  
>  When @code{getopt_long} encounters a long option, it takes actions based
>  on the @code{flag} and @code{val} fields of the definition of that
> -option.
> +option.  The option name may be abbreviated as long as the abbreviation is
> +unique or is an exact match for some defined option.
>  
>  If @code{flag} is a null pointer, then @code{getopt_long} returns the
>  contents of @code{val} to indicate which option it found.  You should

Looks okay.

Reviewed-by: Florian Weimer <fweimer@redhat.com>

Thanks,
Florian

Re: [PATCH] manual: Clarify that abbreviations of long options are allowed

[Andreas Schwab]

On Mai 03 2022, Siddhesh Poyarekar via Libc-alpha wrote:

> diff --git a/manual/getopt.texi b/manual/getopt.texi
> index 5485fc4694..e58283ab88 100644
> --- a/manual/getopt.texi
> +++ b/manual/getopt.texi
> @@ -250,7 +250,8 @@ option, and stores the option's argument (if it has one) in @code{optarg}.
>  
>  When @code{getopt_long} encounters a long option, it takes actions based
>  on the @code{flag} and @code{val} fields of the definition of that
> -option.
> +option.  The option name may be abbreviated as long as the abbreviation is
> +unique or is an exact match for some defined option.

If it's an exact match, it isn't an abbreviation?

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 7578 EB47 D4E5 4D69 2510  2552 DF73 E780 A9DA AEC1
"And now for something completely different."

Re: [PATCH] manual: Clarify that abbreviations of long options are allowed

[Siddhesh Poyarekar]

On 03/05/2022 13:06, Andreas Schwab wrote:
> On Mai 03 2022, Siddhesh Poyarekar via Libc-alpha wrote:
> 
>> diff --git a/manual/getopt.texi b/manual/getopt.texi
>> index 5485fc4694..e58283ab88 100644
>> --- a/manual/getopt.texi
>> +++ b/manual/getopt.texi
>> @@ -250,7 +250,8 @@ option, and stores the option's argument (if it has one) in @code{optarg}.
>>   
>>   When @code{getopt_long} encounters a long option, it takes actions based
>>   on the @code{flag} and @code{val} fields of the definition of that
>> -option.
>> +option.  The option name may be abbreviated as long as the abbreviation is
>> +unique or is an exact match for some defined option.
> 
> If it's an exact match, it isn't an abbreviation?
> 

So just the following?

The option name may be abbreviated as long as the abbreviation is unique.

Thanks,
Siddhesh

Re: [PATCH] manual: Clarify that abbreviations of long options are allowed

[Andreas Schwab]

On Mai 04 2022, Siddhesh Poyarekar wrote:

> The option name may be abbreviated as long as the abbreviation is unique.

Ok.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 7578 EB47 D4E5 4D69 2510  2552 DF73 E780 A9DA AEC1
"And now for something completely different."