One thing I'd like to have around is documentation on how certain
u-boot commands/subsystems work and/or what needs to be done on
certain specific boards.
I'm on a Pinebook Pro here and ${WRKSRC}/doc/README.rockchip
(thanks abieber!) for example has the relevant dd(1) commands to flash
the various blobs -- with that I don't need to try my luck or search
online get a firmware update going and/or prep an SD card.
I know that those README.* files generally also explain how to configure
and build stuff from source and we are not interested in those bits, but
shipping them unmodified is still of value, especially because I can
now work on those boxes while mostly offline.
Besides board specific docs there is general information available
regarding serial console and video output, GPT partitioning from within
u-boot, etc. so I added a few assorted READMEs as well.
Since those ought be shipped regardless of the flavour but and we must
not install the same files via multiple packages I've used PKGSTEM
(contains FLAVOR) as part of the file path such that each FLAVOR may
ship the same docs but under their own unique path.
I have other improvemens in mind but want to take care of them one by
one.
Feedback? OK?
Index: Makefile
===================================================================
RCS file: /cvs/ports/sysutils/u-boot/Makefile,v
retrieving revision 1.80
diff -u -p -r1.80 Makefile
--- Makefile 23 Feb 2021 22:04:35 -0000 1.80
+++ Makefile 23 Mar 2021 19:58:27 -0000
@@ -8,7 +8,7 @@ FLAVOR?= arm
COMMENT= U-Boot firmware
VERSION= 2021.01
-REVISION= 0
+REVISION= 1
DISTNAME= u-boot-${VERSION}
PKGNAME= u-boot-${FLAVOR}-${VERSION:S/-//}
FULLPKGNAME= ${PKGNAME}
@@ -82,6 +82,8 @@ BOARDS=\
rockpro64-rk3399 \
rpi_3 \
rpi_4
+ARCH_READMES=\
+ rockchip
.elif "${FLAVOR}" == "arm"
OMAP=\
omap4_panda \
@@ -140,6 +142,7 @@ BOARDS=\
tinker-rk3288 \
turris_omnia \
vexpress_ca15_tc2
+ARCH_READMES=
.endif
FILES=\
@@ -156,7 +159,15 @@ FILES=\
u-boot.itb \
u-boot-rockchip.bin \
idbloader.img \
- spl/sunxi-spl.bin \
+ spl/sunxi-spl.bin
+
+CMD_READMES+=\
+ console \
+ gpt \
+ nvme \
+ pxe \
+ usb \
+ video
do-build:
.for BOARD in ${BOARDS}
@@ -210,6 +221,11 @@ do-install:
${INSTALL_DATA_DIR} ${PREFIX}/share/u-boot/${BOARD}
-cd ${WRKSRC}/build/${BOARD} && \
cp ${FILES} ${PREFIX}/share/u-boot/${BOARD}/
+.endfor
+ ${INSTALL_DATA_DIR} ${PREFIX}/share/doc/${PKGSTEM}
+.for README in ${ARCH_READMES} ${CMD_READMES}
+ ${INSTALL_DATA} ${WRKSRC}/doc/README.${README} \
+ ${PREFIX}/share/doc/${PKGSTEM}/
.endfor
.include <bsd.port.mk>
Index: pkg/PFRAG.aarch64
===================================================================
RCS file: /cvs/ports/sysutils/u-boot/pkg/PFRAG.aarch64,v
retrieving revision 1.22
diff -u -p -r1.22 PFRAG.aarch64
--- pkg/PFRAG.aarch64 15 Jan 2021 00:01:16 -0000 1.22
+++ pkg/PFRAG.aarch64 23 Mar 2021 19:59:37 -0000
@@ -1,5 +1,13 @@
@comment $OpenBSD: PFRAG.aarch64,v 1.22 2021/01/15 00:01:16 kurt Exp $
@pkgpath sysutils/u-boot-pinebook
+share/doc/u-boot-aarch64/
+share/doc/u-boot-aarch64/README.console
+share/doc/u-boot-aarch64/README.gpt
+share/doc/u-boot-aarch64/README.nvme
+share/doc/u-boot-aarch64/README.pxe
+share/doc/u-boot-aarch64/README.rockchip
+share/doc/u-boot-aarch64/README.usb
+share/doc/u-boot-aarch64/README.video
share/u-boot/
share/u-boot/a64-olinuxino/
share/u-boot/a64-olinuxino/sunxi-spl.bin
Index: pkg/PFRAG.arm
===================================================================
RCS file: /cvs/ports/sysutils/u-boot/pkg/PFRAG.arm,v
retrieving revision 1.24
diff -u -p -r1.24 PFRAG.arm
--- pkg/PFRAG.arm 14 Jan 2021 00:56:54 -0000 1.24
+++ pkg/PFRAG.arm 23 Mar 2021 19:48:37 -0000
@@ -1,5 +1,12 @@
@comment $OpenBSD: PFRAG.arm,v 1.24 2021/01/14 00:56:54 jsg Exp $
@pkgpath sysutils/u-boot,
+share/doc/u-boot-arm/
+share/doc/u-boot-arm/README.console
+share/doc/u-boot-arm/README.gpt
+share/doc/u-boot-arm/README.nvme
+share/doc/u-boot-arm/README.pxe
+share/doc/u-boot-arm/README.usb
+share/doc/u-boot-arm/README.video
share/u-boot/
share/u-boot/A10-OLinuXino-Lime/
share/u-boot/A10-OLinuXino-Lime/sunxi-spl.bin
