Author: Jonas Devlieghere Date: 2022-04-05T09:47:32-07:00 New Revision: e90d8f024b2b6789c1a9fed3b854c45a2db36adc
URL: https://github.com/llvm/llvm-project/commit/e90d8f024b2b6789c1a9fed3b854c45a2db36adc DIFF: https://github.com/llvm/llvm-project/commit/e90d8f024b2b6789c1a9fed3b854c45a2db36adc.diff LOG: [lldb] Improve documentation for some of the platform functions Improve the documentation for the platform functions that take a process host architecture as input. Differential revision: https://reviews.llvm.org/D122767 Added: Modified: lldb/include/lldb/Target/Platform.h Removed: ################################################################################ diff --git a/lldb/include/lldb/Target/Platform.h b/lldb/include/lldb/Target/Platform.h index 6501675cafbfe..3b02f44a7fe21 100644 --- a/lldb/include/lldb/Target/Platform.h +++ b/lldb/include/lldb/Target/Platform.h @@ -94,6 +94,24 @@ class Platform : public PluginInterface { /// attaching to processes unless another platform is specified. static lldb::PlatformSP GetHostPlatform(); + /// Get the platform for the given architecture. See Platform::Create for how + /// a platform is chosen for a given architecture. + /// + /// \param[in] arch + /// The architecture for which we are getting a platform. + /// + /// \param[in] process_host_arch + /// The process host architecture if it's known. An invalid ArchSpec + /// represents that the process host architecture is unknown. + /// + /// \param[out] platform_arch_ptr + /// The architecture which was used to pick the returned platform. This + /// can be diff erent from the input architecture if we're looking for a + /// compatible match instead of an exact match. + /// + /// \return + /// Return the platform that matches the input architecture or the + /// default (invalid) platform if none could be found. static lldb::PlatformSP GetPlatformForArchitecture(const ArchSpec &arch, const ArchSpec &process_host_arch = {}, @@ -111,6 +129,26 @@ class Platform : public PluginInterface { /// candidates output argument diff erentiates between either no platforms /// supporting the given architecture or multiple platforms supporting the /// given architecture. + /// + /// \param[in] arch + /// The architecture for which we are getting a platform. + /// + /// \param[in] process_host_arch + /// The process host architecture if it's known. An invalid ArchSpec + /// represents that the process host architecture is unknown. + /// + /// \param[in] selected_platform_sp + /// The currently selected platform. + /// + /// \param[out] candidates + /// A list of candidate platforms in case multiple platforms could + /// support the given list of architectures. If no platforms match the + /// given architecture the list will be empty. + /// + /// \return + /// Return the platform that matches the input architectures or the + /// default (invalid) platform if no platforms support the given + /// architectures or multiple platforms support the given architecture. static lldb::PlatformSP GetPlatformForArchitectures(std::vector<ArchSpec> archs, const ArchSpec &process_host_arch, @@ -331,6 +369,10 @@ class Platform : public PluginInterface { /// Get the platform's supported architectures in the order in which they /// should be searched. + /// + /// \param[in] process_host_arch + /// The process host architecture if it's known. An invalid ArchSpec + /// represents that the process host architecture is unknown. virtual std::vector<ArchSpec> GetSupportedArchitectures(const ArchSpec &process_host_arch) = 0; _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
