Skip to content

Commit

Permalink
Rollup merge of rust-lang#128535 - mmvanheusden:master, r=workingjubilee
Browse files Browse the repository at this point in the history
Format `std::env::consts` docstrings with markdown backticks

This clarifies possible outputs the constants might be.

**Before:**
--
<img src="https://github.com/user-attachments/assets/8ee8772a-7562-42a2-89be-f8772b76dbd5" width="500px">

**After:**
--
<img src="https://github.com/user-attachments/assets/4632e5e2-db3e-4372-b13e-006cc1701eb1" width="500px">
  • Loading branch information
matthiaskrgr authored Sep 17, 2024
2 parents e9e13a6 + 0328c86 commit 11fe22c
Showing 1 changed file with 107 additions and 66 deletions.
173 changes: 107 additions & 66 deletions library/std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -935,106 +935,147 @@ impl fmt::Debug for ArgsOs {
pub mod consts {
use crate::sys::env::os;

/// A string describing the architecture of the CPU that is currently
/// in use.
/// A string describing the architecture of the CPU that is currently in use.
/// An example value may be: `"x86"`, `"arm"` or `"riscv64"`.
///
/// Some possible values:
/// <details><summary>Full list of possible values</summary>
///
/// - x86
/// - x86_64
/// - arm
/// - aarch64
/// - loongarch64
/// - m68k
/// - csky
/// - mips
/// - mips64
/// - powerpc
/// - powerpc64
/// - riscv64
/// - s390x
/// - sparc64
/// * `"x86"`
/// * `"x86_64"`
/// * `"arm"`
/// * `"aarch64"`
/// * `"m68k"`
/// * `"mips"`
/// * `"mips32r6"`
/// * `"mips64"`
/// * `"mips64r6"`
/// * `"csky"`
/// * `"powerpc"`
/// * `"powerpc64"`
/// * `"riscv32"`
/// * `"riscv64"`
/// * `"s390x"`
/// * `"sparc"`
/// * `"sparc64"`
/// * `"hexagon"`
/// * `"loongarch64"`
///
/// </details>
#[stable(feature = "env", since = "1.0.0")]
pub const ARCH: &str = env!("STD_ENV_ARCH");

/// The family of the operating system. Example value is `unix`.
/// A string describing the family of the operating system.
/// An example value may be: `"unix"`, or `"windows"`.
///
/// This value may be an empty string if the family is unknown.
///
/// <details><summary>Full list of possible values</summary>
///
/// Some possible values:
/// * `"unix"`
/// * `"windows"`
/// * `"itron"`
/// * `"wasm"`
/// * `""`
///
/// - unix
/// - windows
/// </details>
#[stable(feature = "env", since = "1.0.0")]
pub const FAMILY: &str = os::FAMILY;

/// A string describing the specific operating system in use.
/// Example value is `linux`.
/// An example value may be: `"linux"`, or `"freebsd"`.
///
/// Some possible values:
/// <details><summary>Full list of possible values</summary>
///
/// - linux
/// - macos
/// - ios
/// - freebsd
/// - dragonfly
/// - netbsd
/// - openbsd
/// - solaris
/// - android
/// - windows
/// * `"linux"`
/// * `"windows"`
/// * `"macos"`
/// * `"android"`
/// * `"ios"`
/// * `"openbsd"`
/// * `"freebsd"`
/// * `"netbsd"`
/// * `"wasi"`
/// * `"hermit"`
/// * `"aix"`
/// * `"apple"`
/// * `"dragonfly"`
/// * `"emscripten"`
/// * `"espidf"`
/// * `"fortanix"`
/// * `"uefi"`
/// * `"fuchsia"`
/// * `"haiku"`
/// * `"hermit"`
/// * `"watchos"`
/// * `"visionos"`
/// * `"tvos"`
/// * `"horizon"`
/// * `"hurd"`
/// * `"illumos"`
/// * `"l4re"`
/// * `"nto"`
/// * `"redox"`
/// * `"solaris"`
/// * `"solid_asp3`
/// * `"vita"`
/// * `"vxworks"`
/// * `"xous"`
///
/// </details>
#[stable(feature = "env", since = "1.0.0")]
pub const OS: &str = os::OS;

/// Specifies the filename prefix used for shared libraries on this
/// platform. Example value is `lib`.
///
/// Some possible values:
///
/// - lib
/// - `""` (an empty string)
/// Specifies the filename prefix, if any, used for shared libraries on this platform.
/// This is either `"lib"` or an empty string. (`""`).
#[stable(feature = "env", since = "1.0.0")]
pub const DLL_PREFIX: &str = os::DLL_PREFIX;

/// Specifies the filename suffix used for shared libraries on this
/// platform. Example value is `.so`.
///
/// Some possible values:
/// Specifies the filename suffix, if any, used for shared libraries on this platform.
/// An example value may be: `".so"`, `".elf"`, or `".dll"`.
///
/// - .so
/// - .dylib
/// - .dll
/// The possible values are identical to those of [`DLL_EXTENSION`], but with the leading period included.
#[stable(feature = "env", since = "1.0.0")]
pub const DLL_SUFFIX: &str = os::DLL_SUFFIX;

/// Specifies the file extension used for shared libraries on this
/// platform that goes after the dot. Example value is `so`.
/// Specifies the file extension, if any, used for shared libraries on this platform that goes after the dot.
/// An example value may be: `"so"`, `"elf"`, or `"dll"`.
///
/// <details><summary>Full list of possible values</summary>
///
/// Some possible values:
/// * `"so"`
/// * `"dylib"`
/// * `"dll"`
/// * `"sgxs"`
/// * `"a"`
/// * `"elf"`
/// * `"wasm"`
/// * `""` (an empty string)
///
/// - so
/// - dylib
/// - dll
/// </details>
#[stable(feature = "env", since = "1.0.0")]
pub const DLL_EXTENSION: &str = os::DLL_EXTENSION;

/// Specifies the filename suffix used for executable binaries on this
/// platform. Example value is `.exe`.
/// Specifies the filename suffix, if any, used for executable binaries on this platform.
/// An example value may be: `".exe"`, or `".efi"`.
///
/// Some possible values:
///
/// - .exe
/// - .nexe
/// - .pexe
/// - `""` (an empty string)
/// The possible values are identical to those of [`EXE_EXTENSION`], but with the leading period included.
#[stable(feature = "env", since = "1.0.0")]
pub const EXE_SUFFIX: &str = os::EXE_SUFFIX;

/// Specifies the file extension, if any, used for executable binaries
/// on this platform. Example value is `exe`.
/// Specifies the file extension, if any, used for executable binaries on this platform.
/// An example value may be: `"exe"`, or an empty string (`""`).
///
/// <details><summary>Full list of possible values</summary>
///
/// Some possible values:
/// * `"exe"`
/// * `"efi"`
/// * `"js"`
/// * `"sgxs"`
/// * `"elf"`
/// * `"wasm"`
/// * `""` (an empty string)
///
/// - exe
/// - `""` (an empty string)
/// </details>
#[stable(feature = "env", since = "1.0.0")]
pub const EXE_EXTENSION: &str = os::EXE_EXTENSION;
}

0 comments on commit 11fe22c

Please sign in to comment.