Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

FreeBSD: docs update and rootfs detection

Open Beginner friendly
#1,108 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
go

Research direction

Start with docs/tutorials/freebsd-workloads.md, which describes the init_path fallback and the arguments passed to the guest. Then find in the Go code where init_path is set from the container command, and check the docs against it. Done means the tutorial matches that behaviour, and the rootfs-detection question is answered with a measured cost and a recorded decision, with code added only if the cost is low.

Written by the indexing model from the issue text.

Description

documentation enhancement Storage

The FreeBSD docs in urunc don't match how urunc boots FreeBSD guests.

Running without urunit (plain init)

  • The docs say the kernel gets init_path=/urunit:/sbin/urunit:/sbin/init and that images without urunit fall back to /sbin/init. In fact, urunc sets init_path to the first token of the container command, so a non-urunit entrypoint becomes init. The kernel's default init is used only when the command is empty.
  • When init isn't urunit, urunc passes nothing else to the guest: no arguments, env, uid/gid, working directory or network configuration. The docs should say so.

Moreover, urunc doesn't detect the rootfs filesystem. We should check if detection adds extra cost and if not, then we should add it.

Dominant language
Go
Stars
306
Forks
214
Avg merge
2d 3h
Merged PRs (30d)
24

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from urunc-dev/urunc

All issues in urunc-dev/urunc

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.