Rollup merge of #76344 - camelid:patch-6, r=KodrAus

Improve docs for `std::env::args()`

@rustbot modify labels: T-doc
This commit is contained in:
Dylan DPC 2020-09-07 01:18:12 +02:00 committed by GitHub
commit 346d54d1f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -695,21 +695,21 @@ pub struct ArgsOs {
inner: sys::args::Args, inner: sys::args::Args,
} }
/// Returns the arguments which this program was started with (normally passed /// Returns the arguments that this program was started with (normally passed
/// via the command line). /// via the command line).
/// ///
/// The first element is traditionally the path of the executable, but it can be /// The first element is traditionally the path of the executable, but it can be
/// set to arbitrary text, and may not even exist. This means this property should /// set to arbitrary text, and may not even exist. This means this property should
/// not be relied upon for security purposes. /// not be relied upon for security purposes.
/// ///
/// On Unix systems shell usually expands unquoted arguments with glob patterns /// On Unix systems the shell usually expands unquoted arguments with glob patterns
/// (such as `*` and `?`). On Windows this is not done, and such arguments are /// (such as `*` and `?`). On Windows this is not done, and such arguments are
/// passed as-is. /// passed as-is.
/// ///
/// On glibc Linux systems, arguments are retrieved by placing a function in ".init_array". /// On glibc Linux systems, arguments are retrieved by placing a function in `.init_array`.
/// Glibc passes argc, argv, and envp to functions in ".init_array", as a non-standard extension. /// Glibc passes `argc`, `argv`, and `envp` to functions in `.init_array`, as a non-standard
/// This allows `std::env::args` to work even in a `cdylib` or `staticlib`, as it does on macOS /// extension. This allows `std::env::args` to work even in a `cdylib` or `staticlib`, as it
/// and Windows. /// does on macOS and Windows.
/// ///
/// # Panics /// # Panics
/// ///