summaryrefslogtreecommitdiff
path: root/util/checklist
diff options
context:
space:
mode:
authorLee Leahy <leroy.p.leahy@intel.com>2016-08-02 08:23:17 -0700
committerLee Leahy <leroy.p.leahy@intel.com>2016-08-03 18:00:03 +0200
commitce8ff85fe511048d84a3b885cada03a49945df2b (patch)
tree4c87cffe33f8028e027dbd929b5815f66c2fecaa /util/checklist
parent77051e061f1ea6e2aa307ef867740ce2f73d282c (diff)
downloadcoreboot-ce8ff85fe511048d84a3b885cada03a49945df2b.tar.xz
util/checklist: Add usage instructions
Document how to use the checklist and how to generate the data files. TEST=Build and run on Amenia Change-Id: Idffc0683e916cbc5a984028886dc3d89a01d0595 Signed-off-by: Lee Leahy <leroy.p.leahy@intel.com> Reviewed-on: https://review.coreboot.org/16036 Tested-by: build bot (Jenkins) Reviewed-by: Martin Roth <martinroth@google.com>
Diffstat (limited to 'util/checklist')
-rw-r--r--util/checklist/Makefile.inc35
1 files changed, 35 insertions, 0 deletions
diff --git a/util/checklist/Makefile.inc b/util/checklist/Makefile.inc
index e400725609..be872b0118 100644
--- a/util/checklist/Makefile.inc
+++ b/util/checklist/Makefile.inc
@@ -14,6 +14,41 @@
#
###########################################################################
+# Instructions
+###########################################################################
+#
+# Create new control files for checklist:
+#
+# 1. Remove any selection for CREATE_BOARD_CHECKLIST
+# 2. Remove any selection for MAKE_CHECKLIST_PUBLIC
+# 3. make
+# 4. nm build/cbfs/fallback/<stage>.debug > <stage>_symbols.txt
+# 6. sed 's/^...........//' <stage>_symbols.txt > <stage>_complete.dat
+# 7. grep -F " W " <stage>_symbols.txt | sed 's/^...........//' \
+# > <stage>_optional.dat
+# 8. Edit <stage>_complete.dat to remove any symbols that are not
+# desired in the report
+# 9. Edit <stage>_optional.dat to remove any symbols that are
+# required to be implemented
+#
+# Create a board checklist:
+#
+# 1. select CREATE_BOARD_CHECKLIST
+# 2. Optionally: select MAKE_CHECKLIST_PUBLIC
+# 3. Specify CONFIG_CHECKLIST_DATA_FILE_LOCATION
+# 4. make
+#
+# Build Errors:
+# * No checklist built - verify CREATE_BOARD_CHECKLIST is selected in
+# board Kconfig file. Do a make clean
+# * <stage>_complete.dat not found - verify that
+# CONFIG_CHECKLIST_DATA_FILE_LOCATION points to the directory
+# containing the checklist data files. Build the checklist
+# data files if necessary.
+# * Segmentation fault - most likely caused by $(NM_$(class)) not being
+# set.
+#
+###########################################################################
# Build the board implementation checklist
###########################################################################