From 1cb599798a0b29302ab71d1ee0fb9febff8f6a75 Mon Sep 17 00:00:00 2001
From: Felix Morgner <felix.morgner@ost.ch>
Date: Thu, 26 Mar 2026 15:24:10 +0100
Subject: kapi/cpu: update documentation of init()

---
 kapi/include/kapi/cpu.hpp | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'kapi')

diff --git a/kapi/include/kapi/cpu.hpp b/kapi/include/kapi/cpu.hpp
index ade954c..712de16 100644
--- a/kapi/include/kapi/cpu.hpp
+++ b/kapi/include/kapi/cpu.hpp
@@ -14,6 +14,9 @@ namespace kapi::cpu
 
   //! @qualifier platform-defined
   //! Perform early CPU initialization.
+  //!
+  //! When this function returns, the CPU is in a state where interrupt could be enabled. This function must not enable
+  //! interrupts itself.
   auto init() -> void;
 
 }  // namespace kapi::cpu
-- 
cgit v1.2.3