manual: Clarify that abbreviations of long options are allowed
authorSiddhesh Poyarekar <siddhesh@sourceware.org>
Wed, 4 May 2022 10:26:47 +0000 (15:56 +0530)
committerSiddhesh Poyarekar <siddhesh@sourceware.org>
Wed, 4 May 2022 10:26:47 +0000 (15:56 +0530)
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>
Reviewed-by: Florian Weimer <fweimer@redhat.com>
Reviewed-by: Andreas Schwab <schwab@linux-m68k.org>
manual/getopt.texi

index 5485fc4..b4c0b15 100644 (file)
@@ -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.
 
 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