Feature flags of Coreutils crate // Lib.rs

Cargo Features

[dependencies]
coreutils = { version = "0.0.26", default-features = false, features = ["macos", "unix", "windows", "nightly", "test_unimplemented", "uudoc", "feat_acl", "feat_selinux", "feat_common_core", "feat_Tier1", "feat_os_macos", "feat_os_unix", "feat_os_windows", "feat_os_unix_gnueabihf", "feat_os_unix_musl", "feat_os_unix_android", "feat_require_crate_cpp", "feat_require_unix", "feat_require_unix_utmpx", "feat_require_unix_hostid", "feat_require_selinux", "feat_os_unix_fuchsia", "feat_os_unix_redox", "feat_os_windows_legacy", "test"] }

default = feat_common_core

The feat_common_core feature is set by default whenever coreutils is added without default-features = false somewhere in the dependency tree.

macos = feat_os_macos

OS feature shortcodes

unix = feat_os_unix

windows = feat_os_windows

nightly

project-specific feature shortcodes

test_unimplemented

uudoc = zip

only build uudoc when --feature uudoc is activated

Enables uuhelp_parser

Required by the uudoc binary

feat_acl

features "feat_acl" == enable support for ACLs (access control lists; by using--features feat_acl) NOTE:

On linux, the posix-acl/acl-sys crate requires libacl headers and shared library to be accessible in the C toolchain at compile time.

On FreeBSD and macOS this is not required.

Enables feat_acl of uu_cp

feat_selinux = feat_require_selinux, selinux

"feat_selinux" == enable support for SELinux Security Context (by using --features feat_selinux) NOTE:

The selinux(-sys) crate requires libselinux headers and shared library to be accessible in the C toolchain at compile time.

Running a uutils compiled with feat_selinux requires an SELinux enabled Kernel at run time.

Enables selinux of uu_cp, uu_id, and uu_ls

feat_common_core default feat_Tier1? feat_os_unix_fuchsia? feat_os_unix_redox? feat_os_windows_legacy? = base32, base64, basename, basenc, cat, cksum, comm, cp, csplit, cut, date, dd, df, dir, dircolors, dirname, du, echo, env, expand, expr, factor, false, fmt, fold, hashsum, head, join, link, ln, ls, mkdir, mktemp, more, mv, nl, numfmt, od, paste, pr, printenv, printf, ptx, pwd, readlink, realpath, rm, rmdir, seq, shred, shuf, sleep, sort, split, sum, tac, tail, tee, test, touch, tr, true, truncate, tsort, unexpand, uniq, unlink, vdir, wc, yes

feature sets
(common/core and Tier1) feature sets
"feat_common_core" == baseline core set of utilities which can be built/run on most targets

feat_Tier1 feat_os_unix? feat_os_unix_android? feat_os_unix_gnueabihf? feat_os_unix_musl? feat_os_windows? = arch, feat_common_core, hostname, nproc, sync, touch, uname, whoami

"feat_Tier1" == expanded set of utilities which can be built/run on the usual rust "Tier 1" target platforms (ref: https://forge.rust-lang.org/release/platform-support.html)

feat_os_macos macos? = feat_os_unix, feat_require_unix_hostid

(primary platforms) feature sets
"feat_os_macos" == set of utilities which can be built/run on the MacOS platform

feat_os_unix feat_os_macos? unix? = feat_Tier1, feat_require_crate_cpp, feat_require_unix, feat_require_unix_hostid, feat_require_unix_utmpx

"feat_os_unix" == set of utilities which can be built/run on modern/usual *nix platforms

feat_os_windows windows? = feat_Tier1

"feat_os_windows" == set of utilities which can be built/run on modern/usual windows platforms

feat_os_unix_gnueabihf = feat_Tier1, feat_require_unix, feat_require_unix_hostid, feat_require_unix_utmpx

(secondary platforms) feature sets
"feat_os_unix_gnueabihf" == set of utilities which can be built/run on the "arm-unknown-linux-gnueabihf" target (ARMv6 Linux [hardfloat])

feat_os_unix_musl = feat_Tier1, feat_require_unix, feat_require_unix_hostid

"feat_os_unix_musl" == set of utilities which can be built/run on targets binding to the "musl" library (ref: https://musl.libc.org/about.html)

feat_os_unix_android = feat_Tier1, feat_require_unix

feat_require_crate_cpp feat_os_unix? feat_os_unix_fuchsia? = stdbuf

feature sets with requirements (restricting cross-platform availability)

** NOTE: these feat_require_... sets should be minimized as much as possible to encourage cross-platform availability of utilities

"feat_require_crate_cpp" == set of utilities requiring the cpp crate (which fail to compile on several platforms; as of 2020-04-23)

feat_require_unix feat_os_unix? feat_os_unix_android? feat_os_unix_gnueabihf? feat_os_unix_musl? = chgrp, chmod, chown, chroot, groups, id, install, kill, logname, mkfifo, mknod, nice, nohup, pathchk, stat, stty, timeout, tty

"feat_require_unix" == set of utilities requiring support which is only available on unix platforms (as of 2020-04-23)

feat_require_unix_utmpx feat_os_unix? feat_os_unix_gnueabihf? = pinky, uptime, users, who

"feat_require_unix_utmpx" == set of utilities requiring unix utmp/utmpx support

ref: https://wiki.musl-libc.org/faq.html#Q:-Why-is-the-utmp/wtmp-functionality-only-implemented-as-stubs?

feat_require_unix_hostid feat_os_macos? feat_os_unix? feat_os_unix_gnueabihf? feat_os_unix_musl? = hostid

"feat_require_unix_hostid" == set of utilities requiring gethostid in libc (only some unixes provide)

feat_require_selinux feat_selinux? = chcon, runcon

"feat_require_selinux" == set of utilities depending on SELinux.

feat_os_unix_fuchsia = chgrp, chmod, chown, du, feat_common_core, feat_require_crate_cpp, groups, hostid, install, logname, mkfifo, mknod, nice, pathchk, tty, uname, unlink

(alternate/newer/smaller platforms) feature sets "feat_os_unix_fuchsia" == set of utilities which can be built/run on the "Fuchsia" OS (refs: https://fuchsia.dev; https://en.wikipedia.org/wiki/Google_Fuchsia)

feat_os_unix_redox = chmod, feat_common_core, stat, uname

"feat_os_unix_redox" == set of utilities which can be built/run on "Redox OS" (refs: https://www.redox-os.org; https://en.wikipedia.org/wiki/Redox_(operating_system))

feat_os_windows_legacy = arch, feat_common_core, nproc, sync, touch, whoami

"feat_os_windows_legacy" == slightly restricted set of utilities which can be built/run on early windows platforms (eg, "WinXP")

test feat_common_core = uu_test

* bypass/override ~ translate 'test' feature name to avoid dependency collision with rust core 'test' crate (o/w surfaces as compiler errors during testing)

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

selinux feat_selinux?

zip uudoc?

uu_test test?