Skip to content

oci: Update docs for oci.WithUserID#2535

Merged
crosbymichael merged 1 commit intocontainerd:masterfrom
ijc:WithUserID-docs
Aug 8, 2018
Merged

oci: Update docs for oci.WithUserID#2535
crosbymichael merged 1 commit intocontainerd:masterfrom
ijc:WithUserID-docs

Conversation

@ijc
Copy link
Copy Markdown
Contributor

@ijc ijc commented Aug 8, 2018

The behaviour was changed in 99df1a9 ("Set gid 0 when no group is
specified"), part of #2529.

Take the opportunity to tighten up the grammar a bit too.

Signed-off-by: Ian Campbell [email protected]

@codecov-io
Copy link
Copy Markdown

codecov-io commented Aug 8, 2018

Codecov Report

Merging #2535 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2535   +/-   ##
=======================================
  Coverage   45.05%   45.05%           
=======================================
  Files          94       94           
  Lines        9796     9796           
=======================================
  Hits         4414     4414           
  Misses       4662     4662           
  Partials      720      720
Flag Coverage Δ
#linux 49.08% <ø> (ø) ⬆️
#windows 41.57% <ø> (ø) ⬆️
Impacted Files Coverage Δ
oci/spec_opts_unix.go 21.52% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 97473ed...4a74731. Read the comment docs.

Comment thread oci/spec_opts_unix.go Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the new wording can be misunderstood, as a direct reading is "sets the requested uid and gid to zero" meaning both will be set to zero. I think to be clearer it needs separate clauses: "sets the requested uid, additionally sets the gid to 0, and does not return an error."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bah, I reworded it several times to avoid exactly that but clearly ended up with a blind spot. I like your wording, will update.

The behaviour was changed in 99df1a9 ("Set gid 0 when no group is
specified"), part of containerd#2529.

Take the opportunity to tighten up the grammar a bit too.

Signed-off-by: Ian Campbell <[email protected]>
@ijc ijc force-pushed the WithUserID-docs branch from 7598ace to 4a74731 Compare August 8, 2018 14:33
Copy link
Copy Markdown
Member

@estesp estesp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@crosbymichael
Copy link
Copy Markdown
Member

LGTM

@crosbymichael crosbymichael merged commit 2c85ae2 into containerd:master Aug 8, 2018
@ijc ijc deleted the WithUserID-docs branch August 8, 2018 16:40
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.

4 participants