[Lldb-commits] [lldb] [lldb][NFC] Add documentation for OperatingSystem methods (PR #210968)

[Felipe de Azevedo Piovezan via lldb-commits]

https://github.com/felipepiovezan updated https://github.com/llvm/llvm-project/pull/210968

>From 4a2dcd3d310f1afdd17e270ee6b6f3c22fac6de5 Mon Sep 17 00:00:00 2001
From: Felipe de Azevedo Piovezan <fpiovezan at apple.com>
Date: Tue, 21 Jul 2026 10:17:02 +0100
Subject: [PATCH 1/2] [lldb][NFC] Add documentation for OperatingSystem methods

---
 lldb/include/lldb/Target/OperatingSystem.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lldb/include/lldb/Target/OperatingSystem.h b/lldb/include/lldb/Target/OperatingSystem.h
index 128239569790f..df798c47730f3 100644
--- a/lldb/include/lldb/Target/OperatingSystem.h
+++ b/lldb/include/lldb/Target/OperatingSystem.h
@@ -49,10 +49,12 @@ class OperatingSystem : public PluginInterface {
 
   virtual void ThreadWasSelected(Thread *thread) = 0;
 
+  /// Given a thread without a backing thread, create a register context for it.
   virtual lldb::RegisterContextSP
   CreateRegisterContextForThread(Thread *thread,
                                  lldb::addr_t reg_data_addr) = 0;
 
+  /// Given a thread without a backing thread, create a stop reason for it.
   virtual lldb::StopInfoSP CreateThreadStopReason(Thread *thread) = 0;
 
   virtual lldb::ThreadSP CreateThread(lldb::tid_t tid, lldb::addr_t context) {

>From 00346c3b9e59b29d86350432517101565a7fcebd Mon Sep 17 00:00:00 2001
From: Felipe de Azevedo Piovezan <fpiovezan at apple.com>
Date: Fri, 24 Jul 2026 11:00:02 +0100
Subject: [PATCH 2/2] fixup! address review feedback

---
 lldb/include/lldb/Target/OperatingSystem.h | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/lldb/include/lldb/Target/OperatingSystem.h b/lldb/include/lldb/Target/OperatingSystem.h
index df798c47730f3..f81a12fb8c5ab 100644
--- a/lldb/include/lldb/Target/OperatingSystem.h
+++ b/lldb/include/lldb/Target/OperatingSystem.h
@@ -49,12 +49,15 @@ class OperatingSystem : public PluginInterface {
 
   virtual void ThreadWasSelected(Thread *thread) = 0;
 
-  /// Given a thread without a backing thread, create a register context for it.
+  /// RegisterContextThreadMemory gets the RegisterContext from the backing
+  /// thread when it exists; when it doesn't, the OS plugin is used through
+  /// this API.
   virtual lldb::RegisterContextSP
   CreateRegisterContextForThread(Thread *thread,
                                  lldb::addr_t reg_data_addr) = 0;
 
-  /// Given a thread without a backing thread, create a stop reason for it.
+  /// ThreadMemory gets the StopReason from the backing thread when it exists;
+  /// when it doesn't, the OS plugin is used through this API.
   virtual lldb::StopInfoSP CreateThreadStopReason(Thread *thread) = 0;
 
   virtual lldb::ThreadSP CreateThread(lldb::tid_t tid, lldb::addr_t context) {