Skip to content

docs: add [machine] section to config.toml reference#1708

Open
Jonathan5643 wants to merge 2 commits into
apple:mainfrom
Jonathan5643:Jonathan5643-patch-1
Open

docs: add [machine] section to config.toml reference#1708
Jonathan5643 wants to merge 2 commits into
apple:mainfrom
Jonathan5643:Jonathan5643-patch-1

Conversation

@Jonathan5643

@Jonathan5643 Jonathan5643 commented Jun 12, 2026

Copy link
Copy Markdown

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Motivation and Context

The [machine] section was already implemented in ContainerSystemConfig.swift and consumed by MachineCreate.swift as the baseline configuration for container machine create, defining default CPU count, memory allocation, and home directory mount mode for new machines. However, it was missing from the config.toml reference documentation. This change brings the documentation in line with the source code and provides users with a complete reference of available configuration sections.

Source: Sources/ContainerPersistence/MachineConfig.swift

Testing

  • Tested locally
  • Added/updated tests
  • Added/updated docs

The [machine] section in config.toml sets default CPU count, memory allocation, and home directory mount mode for `container machine create`. It was already defined in ContainerSystemConfig and consumed by MachineCreate as the baseline for per-machine boot configuration.

Source: Sources/ContainerPersistence/MachineConfig.swift
@Jonathan5643 Jonathan5643 changed the title add [machine] section to config.toml reference docs: add [machine] section to config.toml reference Jun 12, 2026
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 15, 2026
@github-actions

Copy link
Copy Markdown

Code Coverage

Tier Line Coverage
Unit 33.23%
Integration 21.14%
Combined 53.55%

@katiewasnothere katiewasnothere self-requested a review June 16, 2026 21:00
Comment thread docs/container-system-config.md Outdated
@Jonathan5643 Jonathan5643 force-pushed the Jonathan5643-patch-1 branch from 72c28f3 to 37c4c6c Compare June 17, 2026 04:43
Address review feedback — the original wording incorrectly suggested that container machine set changes take effect on running machines. 
Clarify that the machine must be stopped and restarted.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants