board: Move show_board_info() comment to header file

Move this comment to its prototype and tidy it up a bit.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Tom Rini <trini@konsulko.com>

diff --git a/common/board_info.c b/common/board_info.c
index e0f2d9392204435558f464e93e897916ae84406b..3185793da4a7e6a10a8654f353348185c6a75476 100644 (file)
--- a/common/board_info.c
+++ b/common/board_info.c
@@ -15,12 +15,6 @@ int __weak checkboard(void)
        return 0;
 }
 
-/*
- * Check sysinfo for board information. Failing that if the root node of the DTB
- * has a "model" property, show it.
- *
- * Then call checkboard().
- */
 int __weak show_board_info(void)
 {
        if (IS_ENABLED(CONFIG_OF_CONTROL)) {

diff --git a/include/init.h b/include/init.h
index d57a24fd00dd1072ba6f6dd5d5754a7e8ab76bbe..9a1951d10a0109826e62f777b42a348c9bec0e46 100644 (file)
--- a/include/init.h
+++ b/include/init.h
@@ -292,6 +292,17 @@ int misc_init_r(void);
 
 /* common/board_info.c */
 int checkboard(void);
+
+/**
+ * show_board_info() - Show board information
+ *
+ * Check sysinfo for board information. Failing that if the root node of the DTB
+ * has a "model" property, show it.
+ *
+ * Then call checkboard().
+ *
+ * Return 0 if OK, -ve on error
+ */
 int show_board_info(void);
 
 /**