about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSiddhesh Poyarekar <siddhesh@sourceware.org>2022-05-04 15:56:47 +0530
committerSiddhesh Poyarekar <siddhesh@sourceware.org>2022-05-04 15:56:47 +0530
commitdb1efe02c9f15affc3908d6ae73875b82898a489 (patch)
treeb13ab1c9348ad307c88ab3c86a9a01192a53ab48
parent8e28aa3a51bf0ef3683f2aed4b5b448744897b66 (diff)
downloadglibc-db1efe02c9f15affc3908d6ae73875b82898a489.tar.gz
glibc-db1efe02c9f15affc3908d6ae73875b82898a489.tar.xz
glibc-db1efe02c9f15affc3908d6ae73875b82898a489.zip
manual: Clarify that abbreviations of long options are allowed
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>
-rw-r--r--manual/getopt.texi3
1 files changed, 2 insertions, 1 deletions
diff --git a/manual/getopt.texi b/manual/getopt.texi
index 5485fc4694..b4c0b15ac2 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.
 
 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