Skip to content

Update documentation according to opts updates (#13694)#14727

Merged
thaJeztah merged 1 commit intomoby:masterfrom
vdemeester:opts-docs-updates
Jul 21, 2015
Merged

Update documentation according to opts updates (#13694)#14727
thaJeztah merged 1 commit intomoby:masterfrom
vdemeester:opts-docs-updates

Conversation

@vdemeester
Copy link
Copy Markdown
Member

With #13694 two small things have changed :

  • --env and --envfile are now validated according to the following definition : "Environment variables set by the user must have a name consisting solely of alphabetics, numerics, and underscores - the first of which must not be numeric.".
  • It's possible to use -v containerPath:ro as option for run (and create, …).

I realized I did not think of the documentation when submitting #13694, so this ones try to update the few things it should.

Signed-off-by: Vincent Demeester vincent@sbr.pm

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'd remove the first line and simplify the note to something like

> **Note**: Environment variables names must consist solely of letters, numbers, 
> and underscores - and cannot start with a number.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@SvenDowideit feels way better 😊 updating it 😉

@vdemeester vdemeester force-pushed the opts-docs-updates branch 2 times, most recently from 74f915c to 00568aa Compare July 21, 2015 06:14
@SvenDowideit
Copy link
Copy Markdown
Contributor

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 "As described before," is not needed (Sure, it may be duplicated information but that doesn't hurt).

@thaJeztah
Copy link
Copy Markdown
Member

@vdemeester added some more notes (sorry, I was called away during reviewing)

Question; #13694 is not yet in a release, or is it? If not, I think we should add "impact" labels ("impact/changelog" and "impact/ui"), because the validation-rules changed?

@vdemeester
Copy link
Copy Markdown
Member Author

@thaJeztah It will be in 1.8.0 I believe but yeah, it's not in release 1.7.x.

I agree with you on the impact/* label on the PR. The validation rules changed a little bit but changed, so yeah 🙇.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
@thaJeztah
Copy link
Copy Markdown
Member

Thanks, LGTM!

thaJeztah added a commit that referenced this pull request Jul 21, 2015
Update documentation according to opts updates (#13694)
@thaJeztah thaJeztah merged commit 1e93941 into moby:master Jul 21, 2015
@vdemeester vdemeester deleted the opts-docs-updates branch July 21, 2015 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants