about summary refs log tree commit diff
path: root/src/libstd/os.rs
diff options
context:
space:
mode:
authorLiigo Zhuang <com.liigo@gmail.com>2014-11-14 14:26:13 +0800
committerLiigo Zhuang <com.liigo@gmail.com>2014-11-15 10:01:59 +0800
commit8347450ee61dea57633351aa61586b3c6ee25ed8 (patch)
tree34d263dd0a95dc71563db3f7694a962bba86d407 /src/libstd/os.rs
parent1e4e55aebc1a71b6674c00b8604efa6b1e2e52cd (diff)
downloadrust-8347450ee61dea57633351aa61586b3c6ee25ed8.tar.gz
rust-8347450ee61dea57633351aa61586b3c6ee25ed8.zip
libstd: improve os::args() doc
Diffstat (limited to 'src/libstd/os.rs')
-rw-r--r--src/libstd/os.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libstd/os.rs b/src/libstd/os.rs
index 1402d3a3559..3bc2e5756ad 100644
--- a/src/libstd/os.rs
+++ b/src/libstd/os.rs
@@ -1083,6 +1083,10 @@ extern "system" {
 /// 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