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

config-linux: Consistent header nesting #832

Merged
merged 1 commit into from
May 17, 2017

Conversation

wking
Copy link
Contributor

@wking wking commented May 16, 2017

We have an explicit policy for example header levels, so follow that in config-linux.md. Also adjust the non-example headers to be one level deeper than their parent.

Spun off from here, and we've had similar changes before in #650. After this commit:

$ grep '^#' config-linux.md
# <a name="linuxContainerConfiguration" />Linux Container Configuration
## <a name="configLinuxDefaultFilesystems" />Default Filesystems
## <a name="configLinuxNamespaces" />Namespaces
### Example
## <a name="configLinuxUserNamespaceMappings" />User namespace mappings
### Example
## <a name="configLinuxDevices" />Devices
### Example
### <a name="configLinuxDefaultDevices" />Default Devices
## <a name="configLinuxControlGroups" />Control groups
### Example
### <a name="configLinuxDeviceWhitelist" />Device whitelist
#### Example
### <a name="configLinuxDisableOutOfMemoryKiller" />Disable out-of-memory killer
#### Example
### <a name="configLinuxMemory" />Memory
#### Example
### <a name="configLinuxCPU" />CPU
#### Example
### <a name="configLinuxBlockIO" />Block IO
#### Example
### <a name="configLinuxHugePageLimits" />Huge page limits
#### Example
### <a name="configLinuxNetwork" />Network
#### Example
### <a name="configLinuxPIDS" />PIDs
#### Example
## <a name="configLinuxIntelRdt" />IntelRdt
### Example
## <a name="configLinuxSysctl" />Sysctl
### Example
## <a name="configLinuxSeccomp" />Seccomp
### Example
## <a name="configLinuxRootfsMountPropagation" />Rootfs Mount Propagation
### Example
## <a name="configLinuxMaskedPaths" />Masked Paths
### Example
## <a name="configLinuxReadonlyPaths" />Readonly Paths
### Example
## <a name="configLinuxMountLabel" />Mount Label
### Example

We have an explicit policy for example header levels in style.md, so
follow that in config-linux.md.  Also adjust the non-example headers
to be one level deeper than their parent.

Signed-off-by: W. Trevor King <wking@tremily.us>
@hqhq
Copy link
Contributor

hqhq commented May 17, 2017

LGTM

Approved with PullApprove

1 similar comment
@mrunalp
Copy link
Contributor

mrunalp commented May 17, 2017

LGTM

Approved with PullApprove

@mrunalp mrunalp merged commit 3036273 into opencontainers:master May 17, 2017
wking added a commit to wking/opencontainer-runtime-spec that referenced this pull request May 18, 2017
Through 3036273 (Merge pull request opencontainers#832 from
wking/config-linux-header-levels, 2017-05-17).

Signed-off-by: W. Trevor King <wking@tremily.us>
wking added a commit to wking/opencontainer-runtime-spec that referenced this pull request May 18, 2017
Through 3036273 (Merge pull request opencontainers#832 from
wking/config-linux-header-levels, 2017-05-17).

Signed-off-by: W. Trevor King <wking@tremily.us>
wking added a commit to wking/opencontainer-runtime-spec that referenced this pull request May 18, 2017
Through 3036273 (Merge pull request opencontainers#832 from
wking/config-linux-header-levels, 2017-05-17).

Signed-off-by: W. Trevor King <wking@tremily.us>
wking added a commit to wking/opencontainer-runtime-spec that referenced this pull request May 18, 2017
Through 3036273 (Merge pull request opencontainers#832 from
wking/config-linux-header-levels, 2017-05-17).

Signed-off-by: W. Trevor King <wking@tremily.us>
wking added a commit to wking/opencontainer-runtime-spec that referenced this pull request May 18, 2017
Through 3036273 (Merge pull request opencontainers#832 from
wking/config-linux-header-levels, 2017-05-17).

Signed-off-by: W. Trevor King <wking@tremily.us>
@wking wking deleted the config-linux-header-levels branch May 18, 2017 18:38
@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