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: Fix “procfs_2” → “proc_2” link label #906

Merged

Conversation

wking
Copy link
Contributor

@wking wking commented Jul 28, 2017

Catching up with #905, because it's strange to change one link label from procfsproc but leave the other. This will also make it marginally easier to collapse these to a single link label once we convert the spec to a single Markdown file.

@@ -842,7 +842,7 @@ Here is a full example `config.json` for reference.
[cgroup-v1-memory_2]: https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt
[selinux]:http://selinuxproject.org/page/Main_Page
[no-new-privs]: https://www.kernel.org/doc/Documentation/prctl/no_new_privs.txt
[procfs_2]: https://www.kernel.org/doc/Documentation/filesystems/proc.txt
[proc_2]: https://www.kernel.org/doc/Documentation/filesystems/proc.txt
Copy link
Contributor

Choose a reason for hiding this comment

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

shouldnt this be [proc], nothing refers to proc_2.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

shouldnt this be [proc], nothing refers to proc_2.

Good catch :p; I've pushed 4bb68d9cae2991 to update the earlier link to use proc_2. You can see the broken link for oomScoreAdj in the 1.0.0 release.

With proc* link labels in both config.md and config-linux.md, we need at least one file to use _2 (see our policy here).

Catching up with 56eb6a1 (modify procfs to proc, 2017-07-28, opencontainers#905),
because it's strange to change one link label from "procfs" -> "proc"
but leave the other.  This will also make it marginally easier to
collapse these to a single link label once we convert the spec to a
single Markdown file [1].

[1]: https://groups.google.com/a/opencontainers.org/d/msg/dev/1Wwd_MEzSjI/DsCkR-UwAgAJ
     Subject: [runtime-spec] Hosting 1.0 HTML on opencontainers.org and
       timing for transition to single-page Markdown
     Date: Thu, 27 Jul 2017 16:23:40 -0700
     Message-ID: <20170727232340.GA24408@valgrind.tremily.us>

Signed-off-by: W. Trevor King <wking@tremily.us>
@wking wking force-pushed the procfs-to-proc-link-label branch from 4bb68d9 to cae2991 Compare July 28, 2017 17:12
@tianon
Copy link
Member

tianon commented Jul 28, 2017

LGTM

Approved with PullApprove

1 similar comment
@crosbymichael
Copy link
Member

crosbymichael commented Jul 28, 2017

LGTM

Approved with PullApprove

@crosbymichael crosbymichael merged commit 6d696f5 into opencontainers:master Jul 28, 2017
@wking wking deleted the procfs-to-proc-link-label branch July 28, 2017 17:49
@vbatts vbatts mentioned this pull request Sep 8, 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.

5 participants