Skip to content

Commit e0fe4a7

Browse files
mmvanheusdenmmvanheusden
committed
Add unordered list with possible values for each const
1 parent 84ea721 commit e0fe4a7

File tree

1 file changed

+125
-64
lines changed

1 file changed

+125
-64
lines changed

‎std/src/env.rs

+125-64
Original file line numberDiff line numberDiff line change
@@ -944,106 +944,167 @@ impl fmt::Debug for ArgsOs {
944944
pub mod consts {
945945
use crate::sys::env::os;
946946

947-
/// A string describing the architecture of the CPU that is currently
948-
/// in use.
947+
/// A string describing the architecture of the CPU that is currently in use.
948+
/// An example value may be: `"x86"`, `"arm"` or `"riscv64"`.
949949
///
950-
/// Some possible values:
950+
/// <details><summary>Full list of possible values</summary>
951951
///
952-
/// - `x86`
953-
/// - `x86_64`
954-
/// - `arm`
955-
/// - `aarch64`
956-
/// - `loongarch64`
957-
/// - `m68k`
958-
/// - `csky`
959-
/// - `mips`
960-
/// - `mips64`
961-
/// - `powerpc`
962-
/// - `powerpc64`
963-
/// - `riscv64`
964-
/// - `s390x`
965-
/// - `sparc64`
952+
/// * `"x86"`
953+
/// * `"x86_64"`
954+
/// * `"arm"`
955+
/// * `"aarch64"`
956+
/// * `"m68k"`
957+
/// * `"mips"`
958+
/// * `"mips32r6"`
959+
/// * `"mips64"`
960+
/// * `"mips64r6"`
961+
/// * `"csky"`
962+
/// * `"powerpc"`
963+
/// * `"powerpc64"`
964+
/// * `"riscv32"`
965+
/// * `"riscv64"`
966+
/// * `"s390x"`
967+
/// * `"sparc"`
968+
/// * `"sparc64"`
969+
/// * `"hexagon"`
970+
/// * `"loongarch64"`
971+
///
972+
/// </details>
966973
#[stable(feature = "env", since = "1.0.0")]
967974
pub const ARCH: &str = env!("STD_ENV_ARCH");
968975

969-
/// The family of the operating system. Example value is `unix`.
976+
/// A string describing the family of the operating system.
977+
/// An example value may be: `"unix"`, or `"windows"`.
978+
///
979+
/// This value may be an empty string if the family is unknown.
980+
///
981+
/// <details><summary>Full list of possible values</summary>
970982
///
971-
/// Some possible values:
983+
/// * `"unix"`
984+
/// * `"windows"`
985+
/// * `"itron"`
986+
/// * `""`
972987
///
973-
/// - `unix`
974-
/// - `windows`
988+
/// </details>
975989
#[stable(feature = "env", since = "1.0.0")]
976990
pub const FAMILY: &str = os::FAMILY;
977991

978992
/// A string describing the specific operating system in use.
979-
/// Example value is `linux`.
993+
/// An example value may be: `"linux"`, or `"freebsd"`.
980994
///
981-
/// Some possible values:
995+
/// <details><summary>Full list of possible values</summary>
982996
///
983-
/// - `linux`
984-
/// - `macos`
985-
/// - `ios`
986-
/// - `freebsd`
987-
/// - `dragonfly`
988-
/// - `netbsd`
989-
/// - `openbsd`
990-
/// - `solaris`
991-
/// - `android`
992-
/// - `windows`
997+
/// * `"linux"`
998+
/// * `"windows"`
999+
/// * `"macos"`
1000+
/// * `"android"`
1001+
/// * `"ios"`
1002+
/// * `"openbsd"`
1003+
/// * `"freebsd"`
1004+
/// * `"netbsd"`
1005+
/// * `"wasi"`
1006+
/// * `"hermit"`
1007+
/// * `"aix"`
1008+
/// * `"apple"`
1009+
/// * `"dragonfly"`
1010+
/// * `"emscripten"`
1011+
/// * `"espidf"`
1012+
/// * `"fortanix"`
1013+
/// * `"uefi"`
1014+
/// * `"fuchsia"`
1015+
/// * `"haiku"`
1016+
/// * `"hermit"`
1017+
/// * `"watchos"`
1018+
/// * `"visionos"`
1019+
/// * `"tvos"`
1020+
/// * `"horizon"`
1021+
/// * `"hurd"`
1022+
/// * `"illumos"`
1023+
/// * `"l4re"`
1024+
/// * `"nto"`
1025+
/// * `"redox"`
1026+
/// * `"solaris"`
1027+
/// * `"solid_asp3`
1028+
/// * `"vita"`
1029+
/// * `"vxworks"`
1030+
/// * `"xous"`
1031+
///
1032+
/// </details>
9931033
#[stable(feature = "env", since = "1.0.0")]
9941034
pub const OS: &str = os::OS;
9951035

996-
/// Specifies the filename prefix used for shared libraries on this
997-
/// platform. Example value is `lib`.
998-
///
999-
/// Some possible values:
1000-
///
1001-
/// - `lib`
1002-
/// - `""` (an empty string)
1036+
/// Specifies the filename prefix, if any, used for shared libraries on this platform.
1037+
/// This is either `"lib"` or an empty string. (`""`).
10031038
#[stable(feature = "env", since = "1.0.0")]
10041039
pub const DLL_PREFIX: &str = os::DLL_PREFIX;
10051040

1006-
/// Specifies the filename suffix used for shared libraries on this
1007-
/// platform. Example value is `.so`.
1041+
/// Specifies the filename suffix, if any, used for shared libraries on this platform.
1042+
/// An example value may be: `".so"`, `".elf"`, or `".dll"`.
1043+
///
1044+
/// <details><summary>Full list of possible values</summary>
10081045
///
1009-
/// Some possible values:
1046+
/// * `".so"`
1047+
/// * `".dylib"`
1048+
/// * `".dll"`
1049+
/// * `".sgxs"`
1050+
/// * `".a"`
1051+
/// * `".elf"`
1052+
/// * `".wasm"`
1053+
/// * `""` (an empty string)
10101054
///
1011-
/// - `.so`
1012-
/// - `.dylib`
1013-
/// - `.dll`
1055+
/// </details>
10141056
#[stable(feature = "env", since = "1.0.0")]
10151057
pub const DLL_SUFFIX: &str = os::DLL_SUFFIX;
10161058

1017-
/// Specifies the file extension used for shared libraries on this
1018-
/// platform that goes after the dot. Example value is `so`.
1059+
/// Specifies the file extension, if any, used for shared libraries on this platform that goes after the dot.
1060+
/// An example value may be: `"so"`, `"elf"`, or `"dll"`.
1061+
///
1062+
/// <details><summary>Full list of possible values</summary>
10191063
///
1020-
/// Some possible values:
1064+
/// * `"so"`
1065+
/// * `"dylib"`
1066+
/// * `"dll"`
1067+
/// * `"sgxs"`
1068+
/// * `"a"`
1069+
/// * `"elf"`
1070+
/// * `"wasm"`
1071+
/// * `""` (an empty string)
10211072
///
1022-
/// - `so`
1023-
/// - `dylib`
1024-
/// - `dll`
1073+
/// </details>
10251074
#[stable(feature = "env", since = "1.0.0")]
10261075
pub const DLL_EXTENSION: &str = os::DLL_EXTENSION;
10271076

1028-
/// Specifies the filename suffix used for executable binaries on this
1029-
/// platform. Example value is `.exe`.
1077+
/// Specifies the filename suffix, if any, used for executable binaries on this platform.
1078+
/// An example value may be: `".exe"`, or `".efi"`.
10301079
///
1031-
/// Some possible values:
1080+
/// <details><summary>Full list of possible values</summary>
10321081
///
1033-
/// - `.exe`
1034-
/// - `.nexe`
1035-
/// - `.pexe`
1036-
/// - `""` (an empty string)
1082+
/// * `".exe"`
1083+
/// * `".efi"`
1084+
/// * `".js"`
1085+
/// * `".sgxs"`
1086+
/// * `".elf"`
1087+
/// * `".wasm"`
1088+
/// * `""` (an empty string)
1089+
///
1090+
/// </details>
10371091
#[stable(feature = "env", since = "1.0.0")]
10381092
pub const EXE_SUFFIX: &str = os::EXE_SUFFIX;
10391093

1040-
/// Specifies the file extension, if any, used for executable binaries
1041-
/// on this platform. Example value is `exe`.
1094+
/// Specifies the file extension, if any, used for executable binaries on this platform.
1095+
/// An example value may be: `"exe"`, or an empty string (`""`).
1096+
///
1097+
/// <details><summary>Full list of possible values</summary>
10421098
///
1043-
/// Some possible values:
1099+
/// * `"exe"`
1100+
/// * `"efi"`
1101+
/// * `"js"`
1102+
/// * `"sgxs"`
1103+
/// * `"elf"`
1104+
/// * `"wasm"`
1105+
/// * `""` (an empty string)
10441106
///
1045-
/// - `exe`
1046-
/// - `""` (an empty string)
1107+
/// </details>
10471108
#[stable(feature = "env", since = "1.0.0")]
10481109
pub const EXE_EXTENSION: &str = os::EXE_EXTENSION;
10491110
}

0 commit comments

Comments
 (0)