colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

man/cli: add NOTES section with disclaimer for name abbreviations

Browse Source 
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 <thaller@redhat.com>
This commit is contained in:
Thomas Haller
2013-12-13 13:27:43 +01:00
committed by Jiří Klimeš
parent 7fa79fcc5e
commit 600763e773
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
man/nmcli.1.in
View File

@@ -878,6 +878,12 @@ modifies 'autoconnect' property in the 'connection' setting of 'ethernet\(hy2' c
.IP .IP
modifies 'mtu' property in the 'wifi' setting of 'Home Wi\(hyFi' connection. 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 .SH BUGS
There are probably some bugs. If you find a bug, please report it to There are probably some bugs. If you find a bug, please report it to
https://bugzilla.gnome.org/ \(em product \fINetworkManager\fP. https://bugzilla.gnome.org/ \(em product \fINetworkManager\fP.