Skip to content

Commit 0401617

Browse files
committed
Rollup merge of rust-lang#25668 - steveklabnik:doc_const, r=alexcrichton
2 parents 689e94b + 04c7b82 commit 0401617

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

Diff for: src/libstd/env.rs

+54
Original file line numberDiff line numberDiff line change
@@ -598,40 +598,94 @@ pub fn page_size() -> usize {
598598
pub mod consts {
599599
/// A string describing the architecture of the CPU that this is currently
600600
/// in use.
601+
///
602+
/// Some possible values:
603+
///
604+
/// - x86
605+
/// - x86_64
606+
/// - arm
607+
/// - aarch64
608+
/// - mips
609+
/// - mipsel
610+
/// - powerpc
601611
#[stable(feature = "env", since = "1.0.0")]
602612
pub const ARCH: &'static str = super::arch::ARCH;
603613

604614
/// The family of the operating system. In this case, `unix`.
615+
///
616+
/// Some possible values:
617+
///
618+
/// - unix
619+
/// - windows
605620
#[stable(feature = "env", since = "1.0.0")]
606621
pub const FAMILY: &'static str = super::os::FAMILY;
607622

608623
/// A string describing the specific operating system in use: in this
609624
/// case, `linux`.
625+
///
626+
/// Some possible values:
627+
///
628+
/// - linux
629+
/// - macos
630+
/// - ios
631+
/// - freebsd
632+
/// - dragonfly
633+
/// - bitrig
634+
/// - openbsd
635+
/// - android
636+
/// - windows
610637
#[stable(feature = "env", since = "1.0.0")]
611638
pub const OS: &'static str = super::os::OS;
612639

613640
/// Specifies the filename prefix used for shared libraries on this
614641
/// platform: in this case, `lib`.
642+
///
643+
/// Some possible values:
644+
///
645+
/// - lib
646+
/// - `""` (an empty string)
615647
#[stable(feature = "env", since = "1.0.0")]
616648
pub const DLL_PREFIX: &'static str = super::os::DLL_PREFIX;
617649

618650
/// Specifies the filename suffix used for shared libraries on this
619651
/// platform: in this case, `.so`.
652+
///
653+
/// Some possible values:
654+
///
655+
/// - .so
656+
/// - .dylib
657+
/// - .dll
620658
#[stable(feature = "env", since = "1.0.0")]
621659
pub const DLL_SUFFIX: &'static str = super::os::DLL_SUFFIX;
622660

623661
/// Specifies the file extension used for shared libraries on this
624662
/// platform that goes after the dot: in this case, `so`.
663+
///
664+
/// Some possible values:
665+
///
666+
/// - .so
667+
/// - .dylib
668+
/// - .dll
625669
#[stable(feature = "env", since = "1.0.0")]
626670
pub const DLL_EXTENSION: &'static str = super::os::DLL_EXTENSION;
627671

628672
/// Specifies the filename suffix used for executable binaries on this
629673
/// platform: in this case, the empty string.
674+
///
675+
/// Some possible values:
676+
///
677+
/// - exe
678+
/// - `""` (an empty string)
630679
#[stable(feature = "env", since = "1.0.0")]
631680
pub const EXE_SUFFIX: &'static str = super::os::EXE_SUFFIX;
632681

633682
/// Specifies the file extension, if any, used for executable binaries
634683
/// on this platform: in this case, the empty string.
684+
///
685+
/// Some possible values:
686+
///
687+
/// - exe
688+
/// - `""` (an empty string)
635689
#[stable(feature = "env", since = "1.0.0")]
636690
pub const EXE_EXTENSION: &'static str = super::os::EXE_EXTENSION;
637691

0 commit comments

Comments
 (0)