From 600763e77307587532e6069bb7ae4ec89c377b37 Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Fri, 13 Dec 2013 13:27:43 +0100 Subject: [PATCH] man/cli: add NOTES section with disclaimer for name abbreviations Make clear, that only full names are guaranteed to work in future versions. The use of some abbreviations might break as new options get added. It would be rather complicated, to ensure, that abbreviations always continue to work, at the additional disadvantage, that they no longer uniquely identify an option. Instead, clearly state that using them is not guaranteed to work in the future. Users that care about long term compatibility should instead spell out the full names. Abbreviations are mainly here for interactive use. Signed-off-by: Thomas Haller --- man/nmcli.1.in | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/man/nmcli.1.in b/man/nmcli.1.in index d07878c765..5e6197910b 100644 --- a/man/nmcli.1.in +++ b/man/nmcli.1.in @@ -878,6 +878,12 @@ modifies 'autoconnect' property in the 'connection' setting of 'ethernet\(hy2' c .IP modifies 'mtu' property in the 'wifi' setting of 'Home Wi\(hyFi' connection. +.SH NOTES +\fInmcli\fP accepts abbreviations, as long as they are a unique prefix in the set +of possible options. As new options get added, these abbreviations are not guaranteed +to stay unique. For scripting and long term compatiblity it is therefore strongly +advised to spell out the full option names. + .SH BUGS There are probably some bugs. If you find a bug, please report it to https://bugzilla.gnome.org/ \(em product \fINetworkManager\fP.