Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

*: Use inline links for remaining internal references #799

Merged
merged 1 commit into from
May 10, 2017

Conversation

wking
Copy link
Contributor

@wking wking commented May 10, 2017

Since #687, the official style is to only use reference-style links for external links. I expect the remaining three entries just slipped through. This commit adjusts everything found with:

$ git grep ']: [a-z]' | grep -v http

It also fixes the underscore → hyphen in the glossary.md#container-namespace target and updates the capabilities location to catch up with #329.

Since f9dc90b (make link usage consistent across the specification,
2017-02-09, opencontainers#687), the official style is to only use reference-style
links for external links.  I expect the remaining three entries just
slipped through.  This commit adjusts everything found with:

  $ git grep ']: [a-z]' | grep -v http

It also fixes the underscore -> hyphen in the
glossary.md#container-namespace target and updates the capabilities
location to catch up with 5a8a779 (Move process specific settings to
process, 2016-03-02, opencontainers#329).

Signed-off-by: W. Trevor King <wking@tremily.us>
The config JSON isn't enough of a UI to be worth jumping through string <-> integer hoops to support an 0x… form ([source][integer-over-hex]).

## <a name="styleConstantNames" />Constant names should keep redundant prefixes

For example, `CAP_KILL` instead of `KILL` in [**`linux.capabilities`**][capabilities].
For example, `CAP_KILL` instead of `KILL` in [**`process.capabilities`**](config.md#process).
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this be config.md#configProcess?

(## <a name="configProcess" />Process is the section header of config.md which mentions capabilities)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Shouldn't this be config.md#configProcess?

That would work too. I'm currently using the auto-generated fragments to match @mrunalp's preference. I don't care either way, although I'd prefer the spec consistently use whichever way maintainers want.

@tianon
Copy link
Member

tianon commented May 10, 2017

LGTM

Thanks for clarifying @wking. 👍

Approved with PullApprove

@mrunalp
Copy link
Contributor

mrunalp commented May 10, 2017

LGTM

Approved with PullApprove

@mrunalp mrunalp merged commit cde4b66 into opencontainers:master May 10, 2017
@wking wking deleted the inline-internal-links branch May 10, 2017 23:51
@vbatts vbatts mentioned this pull request Jul 5, 2017
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