Skip to content

user: touch-up GoDoc for MkdirAndChown / MkdirAllAndChown#237

Merged
vvoland merged 1 commit into
moby:mainfrom
thaJeztah:user_touchup_docs
Jul 23, 2026
Merged

user: touch-up GoDoc for MkdirAndChown / MkdirAllAndChown#237
vvoland merged 1 commit into
moby:mainfrom
thaJeztah:user_touchup_docs

Conversation

@thaJeztah

@thaJeztah thaJeztah commented Jul 23, 2026

Copy link
Copy Markdown
Member

user: touch-up GoDoc for MkdirAndChown / MkdirAllAndChown

The previous GoDoc was ambiguous about which existing directories have
their ownership and permissions updated. In particular, it could be read
as applying changes to existing parent directories, while the
implementation only updates:

  • the requested directory (unless WithOnlyNew is specified), and
  • parent directories that were newly created.

Also align the documentation more closely with the corresponding
os.Mkdir and os.MkdirAll documentation, and document the key behavioral
differences, including the resulting permissions being independent of the
process umask.

The previous GoDoc was ambiguous about which existing directories have
their ownership and permissions updated. In particular, it could be read
as applying changes to existing parent directories, while the
implementation only updates:

- the requested directory (unless WithOnlyNew is specified), and
- parent directories that were newly created.

Also align the documentation more closely with the corresponding
os.Mkdir and os.MkdirAll documentation, and document the key behavioral
differences, including the resulting permissions being independent of the
process umask.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Copilot AI review requested due to automatic review settings July 23, 2026 10:36

This comment was marked as off-topic.

@thaJeztah
thaJeztah force-pushed the user_touchup_docs branch from 8d8a3d4 to 8ce2731 Compare July 23, 2026 10:53
Copilot AI review requested due to automatic review settings July 23, 2026 10:53

This comment was marked as off-topic.

@vvoland
vvoland merged commit d7c3b9e into moby:main Jul 23, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants