-
Notifications
You must be signed in to change notification settings - Fork 8.2k
[docs-scanner] Missing deprecation notice for --kernel-memory flag #24643
Description
File: content/manuals/engine/containers/resource_constraints.md
Issue
The documentation describes the --kernel-memory flag without any deprecation notice:
--kernel-memory| The maximum amount of kernel memory the container can use. The minimum allowed value is6m. Because kernel memory can't be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See--kernel-memorydetails.
The flag is then documented in detail in a dedicated section, with no mention that it has been deprecated.
Why this matters
The --kernel-memory flag was deprecated in Docker Engine 20.10 (released December 2020) and is no longer functional in current Docker versions. Users following this documentation will attempt to use a flag that doesn't work, leading to confusion. The documentation at the end mentions that cgroup v2 discards this flag, but this is buried and doesn't clearly communicate that the flag is deprecated across all configurations.
Suggested fix
Add a deprecation notice to the --kernel-memory row in the table and to the detailed section. For example:
--kernel-memory| Deprecated. This flag was deprecated in Docker Engine 20.10 and is not functional in cgroup v2 environments. The maximum amount of kernel memory the container can use...
Or remove the detailed documentation for this flag entirely and replace it with a brief deprecation notice pointing users to alternative approaches for memory management.
Found by nightly documentation quality scanner