compiler: Add a comment to host_build()
authorSimon Glass <sjg@chromium.org>
Sat, 25 Sep 2021 13:03:08 +0000 (07:03 -0600)
committerTom Rini <trini@konsulko.com>
Fri, 8 Oct 2021 19:53:26 +0000 (15:53 -0400)
This function should have a comment explaining what it does. Add one.

Signed-off-by: Simon Glass <sjg@chromium.org>
include/compiler.h

index 27b9843..67e5205 100644 (file)
@@ -151,6 +151,11 @@ typedef unsigned long int uintptr_t;
 #define MEM_SUPPORT_64BIT_DATA 0
 #endif
 
+/**
+ * host_build() - check if we are building for the host
+ *
+ * @return true if building for the host, false if for a target
+ */
 static inline bool host_build(void) {
 #ifdef USE_HOSTCC
        return true;