about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorJakub Bukaj <jakub@jakub.cc>2014-11-19 22:37:15 +0100
committerJakub Bukaj <jakub@jakub.cc>2014-11-19 22:37:15 +0100
commitf6b4e398b9dee98f847e917a30c545a24ff17c28 (patch)
tree3a077d586cecd1d7c10195a13e4e5b02a01311fb /src/libstd
parent0191b4983ec51df076d8d6f536d603ec2dc4148f (diff)
parent8347450ee61dea57633351aa61586b3c6ee25ed8 (diff)
downloadrust-f6b4e398b9dee98f847e917a30c545a24ff17c28.tar.gz
rust-f6b4e398b9dee98f847e917a30c545a24ff17c28.zip
rollup merge of #18944: liigo/improve-os-args-doc
Diffstat (limited to 'src/libstd')
-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 b898b9a2df4..68ddabfd48f 100644
--- a/src/libstd/os.rs
+++ b/src/libstd/os.rs
@@ -1108,6 +1108,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