UniXNU/docs/reference/index.md

Technical reference

Use this page to find the file, procedure and verification for a change. For a complete workflow, follow Port a device or Build and boot. Device values and current results are listed in Devices.

1. Find the setting or implementation

Change	File or implementation	Procedure
Local input paths	Main checkout unixnu.local.toml	Configure build inputs
Device, SoC or component selection	Device board.toml, feeds.toml, configs/	Resolve the port
Hardware resources	SoC DTSI and board DTS	Device tree
Driver behavior	Selected component or board package	Adapt hardware, develop a driver
Kernel behavior	Owning profile or component patch series	Change XNU
XNU command line	[payload] kernel_args or local [build] kernel_args	Apply boot arguments
Boot menu or kit	Payload EFI/UniXNU/unixnu.toml, kit Kit.toml	Boot configuration
Device support record	Device porting.toml and main devices.toml	Update and publish the record
Documentation	Main checkout docs/, English and Chinese	Edit and publish documentation

Result: identify the owning file and the procedure before editing it.

2. Read the matching reference

Subject	References
Build driver	Commands and options, configuration fields, output paths and reports
Components	Catalog and source identity, repositories and component pages
Driver interfaces	UEFI drivers, built-in XNU drivers, kext bundles, device-tree matching
XNU	Source and patch ownership, patch catalog, 4 KiB page tables
Boot and image formats	Boot chain, prelink, payload, userdata layout, boot configuration
Integrity	Trust caches and boot policy
Project structure	Repository ownership, terms

The field tables give accepted values and paths. Follow the linked procedure for the required order and build commands.

3. Verify the affected output

Run commands from the main checkout with the intended device selected:

./unixnu status --json

Check the device, OS profile, configuration, module origins and output directory. Then use the verification for the change:

Change	Verification	Expected result
Kernel, driver or patches	Kernel build, then bring-up	Kernel and prelink succeed; record the affected device checkpoint separately
Firmware or payload	Build and boot	Updated FD, payload and boot image use the intended inputs
Boot arguments	Inspect payload configuration	Packaged args match the intended command line
Common UEFI behavior	QEMU procedure	Selected scenario reaches its expected log markers
Porting record or documentation	Record check, site build	Record validation and documentation build pass

For a failed step, follow troubleshooting and save the command, input revisions and relevant logs.