Skip to content

mount: bind-recursive: remove boolean convenience values#4671

Merged
thaJeztah merged 1 commit intodocker:masterfrom
thaJeztah:bind_recusrive_no_bool
Nov 22, 2023
Merged

mount: bind-recursive: remove boolean convenience values#4671
thaJeztah merged 1 commit intodocker:masterfrom
thaJeztah:bind_recusrive_no_bool

Conversation

@thaJeztah
Copy link
Member

Commit fc6976d (#4316) introduced support for the bind-recursive option on --mount, and deprecated the bind-nonrecursive option. Unlike bind-nonrecursive boolean, the bind-recursive option accepts a string value with multiple options.

For convenience, the bind-recursive option also was made to accept boolean values (true/false, 1/0). However, as the option works as the reverse of bind-nonrecursive (bind-nonrecursive=true === bind-recursive=false), the new option won't be a "drop-in" replacement, and having more options to choose from may only be adding more complexity / cognitive overload.

This patch removes support for boolean values; if we see a need to add support for boolean values in future, it would be trivial to add back this functionality.

- A picture of a cute animal (not mandatory but encouraged)

- updates fc6976d
- updates 74bace1

Commit fc6976d introduced support for the
`bind-recursive` option on `--mount`, and deprecated the `bind-nonrecursive`
option.  Unlike `bind-nonrecursive` boolean, the `bind-recursive` option
accepts a string value with multiple options.

For convenience, the `bind-recursive` option also was made to accept boolean
values (true/false, 1/0). However, as the option works as the _reverse_ of
`bind-nonrecursive` (`bind-nonrecursive=true` === `bind-recursive=false`),
the new option won't be a "drop-in" replacement, and having more options
to choose from may only be adding more complexity / cognitive overload.

This patch removes support for boolean values; if we see a need to add
support for boolean values in future, it would be trivial to add back this
functionality.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@codecov-commenter
Copy link

codecov-commenter commented Nov 22, 2023

Codecov Report

Merging #4671 (7be05a6) into master (1401f91) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4671      +/-   ##
==========================================
+ Coverage   59.72%   59.73%   +0.01%     
==========================================
  Files         287      287              
  Lines       24832    24824       -8     
==========================================
- Hits        14831    14829       -2     
+ Misses       9115     9110       -5     
+ Partials      886      885       -1     
@thaJeztah
Copy link
Member Author

@thaJeztah
Copy link
Member Author

Thanks for review! Let me bring this one in

@thaJeztah thaJeztah merged commit 8046bb2 into docker:master Nov 22, 2023
@thaJeztah thaJeztah deleted the bind_recusrive_no_bool branch November 22, 2023 10:49
thaJeztah added a commit to thaJeztah/cli that referenced this pull request Aug 5, 2025
The `bind-nonrecursive` option was replaced with the [`bind-recursive`]
option (see [cli-4316], [cli-4671]). The option was still accepted, but
printed a deprecation warning:

    bind-nonrecursive is deprecated, use bind-recursive=disabled instead

In the v29.0 release, this warning is removed, and returned as an error.
Users should use the equivalent `bind-recursive=disabled` option instead.

[`bind-recursive`]: https://docs.docker.com/engine/storage/bind-mounts/#recursive-mounts
[cli-4316]: docker#4316
[cli-4671]: docker#4671

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah added a commit to thaJeztah/cli that referenced this pull request Aug 19, 2025
The `bind-nonrecursive` option was replaced with the [`bind-recursive`]
option (see [cli-4316], [cli-4671]), but the deprecated docs was not
updated to mention.

Based on abfe4d4 in master

[`bind-recursive`]: https://docs.docker.com/engine/storage/bind-mounts/#recursive-mounts
[cli-4316]: docker#4316
[cli-4671]: docker#4671

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit abfe4d4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah added a commit to thaJeztah/cli that referenced this pull request Aug 19, 2025
The `bind-nonrecursive` option was replaced with the [`bind-recursive`]
option (see [cli-4316], [cli-4671]), but the deprecated docs was not
updated to mention.

Based on abfe4d4 in master

[`bind-recursive`]: https://docs.docker.com/engine/storage/bind-mounts/#recursive-mounts
[cli-4316]: docker#4316
[cli-4671]: docker#4671

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit abfe4d4)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment