Skip to content

runc: add page - #24950

Open
kennedys0 wants to merge 1 commit into
tldr-pages:mainfrom
kennedys0:main
Open

kennedys0 wants to merge 1 commit into
tldr-pages:mainfrom
kennedys0:main

Conversation

@kennedys0

Copy link
Copy Markdown

Checklist

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR contains at most 5 new pages.
  • The PR is authored by me, or has been human-reviewed if it was created with AI or machine translation software (see AI-Assisted Development Policy).
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known): v1.5.2
  • Reference issue: Page request: runc #24949
  • Closes: Page request: runc #24949

Additional details:

@CLAassistant

CLAassistant commented Oct 31, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions Bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Oct 31, 2026

@paoValle paoValle left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Read against runc's man page: spec, create --bundle, start, list, state, kill and delete --force all match the CLI, the approach section is right, and pages/linux/ is the correct directory for a Linux-only tool. Two gaps before merge:

  • runc exec is missing. Running a command inside a container that is already up is the operation people reach for after run, and the page otherwise only covers the create/start/delete lifecycle.
  • Every example assumes root. That is accurate for the common case, but rootless runc needs its own state directory (runc --root {{path/to/state_dir}} run {{container_id}}); a note or one example would cover the case that sends people looking for this page in the first place.

runc pause/resume would also fit if you want a seventh example, but the two above are the ones I would not ship without.

@kennedys0

Copy link
Copy Markdown
Author

@paoValle both points addressed in a2c130d:

  • Added runc exec with an optional --tty placeholder, placed right after start in the lifecycle.
  • Added a rootless note in the heading covering --root {{path/to/state_dir}} for the state directory.

Dropped the state example to stay within the 8-example limit (TLDR019) — list already covers container visibility. Syntax for exec (--tty/-t) and the global --root option verified against the runc man pages in the runc repo.

@paoValle paoValle left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Both points are in: runc exec sits right after start, and the rootless note names --root. tldr-lint and markdownlint are clean on the page, the link matches more-info-links.txt, and 8 examples is inside the limit.

One optional nit: it is the only page in the corpus with a {{placeholder}} inside a > Note: line — --root bare there, or the path moved into an example, would match every other note. Either way this looks good to me.

Comment thread pages/linux/runc.md
> Run applications packaged according to the Open Container Initiative (OCI) format.
> Note: Rootless containers can store their state in a custom directory with `--root {{path/to/state_dir}}`.
> See also: `ctr`, `nerdctl`.
> More information: <https://manpages.debian.org/latest/runc/runc.8.html>.

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.

Suggested change
> More information: <https://manpages.debian.org/latest/runc/runc.8.html>.
> More information: <https://manned.org/man/runc>.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.

4 participants