]> git.lizzy.rs Git - rust.git/commitdiff
libstd: improve os::args() doc
authorLiigo Zhuang <com.liigo@gmail.com>
Fri, 14 Nov 2014 06:26:13 +0000 (14:26 +0800)
committerLiigo Zhuang <com.liigo@gmail.com>
Sat, 15 Nov 2014 02:01:59 +0000 (10:01 +0800)
src/libstd/os.rs

index 1402d3a3559056486688c98eefaf6a44c0f5c979..3bc2e5756ad231af8cda82d5f4be5b3e4a731295 100644 (file)
@@ -1083,6 +1083,10 @@ fn CommandLineToArgvW(lpCmdLine: LPCWSTR,
 /// Returns the arguments which this program was started with (normally passed
 /// via the command line).
 ///
+/// The first element is traditionally the path to the executable, but it can be
+/// set to arbitrary text, and it may not even exist, so this property should not
+//  be relied upon for security purposes.
+///
 /// The arguments are interpreted as utf-8, with invalid bytes replaced with \uFFFD.
 /// See `String::from_utf8_lossy` for details.
 /// # Example