Merge pull request #2015 from hermit-os/qemu-exit-comment

mkroening · web-flow · commit 795a594bab44 · 2025-10-28T09:21:26.000Z
docs(x86_64): add explantory comment to `qemu_exit`
diff --git a/src/arch/x86_64/kernel/processor.rs b/src/arch/x86_64/kernel/processor.rs
@@ -1088,6 +1088,9 @@ fn triple_fault() -> ! {
 	unreachable!()
 }
 
+/// Writes an exit code into the isa-debug-exit port.
+///
+/// For a value `e` written into the port, QEMU will exit with `(e << 1) | 1`.
 fn qemu_exit(success: bool) {
 	let code = if success { 3 >> 1 } else { 0 };
 	unsafe {

Original file line number	Diff line number	Diff line change
`@@ -1088,6 +1088,9 @@ fn triple_fault() -> ! {`
`1088`	`1088`	`unreachable!()`
`1089`	`1089`	`}`
`1090`	`1090`
	`1091`	`+/// Writes an exit code into the isa-debug-exit port.`
	`1092`	`+///`
	`1093`	+/// For a value `e` written into the port, QEMU will exit with `(e << 1) \| 1`.
`1091`	`1094`	`fn qemu_exit(success: bool) {`
`1092`	`1095`	`let code = if success { 3 >> 1 } else { 0 };`
`1093`	`1096`	`unsafe {`