Clean up & document scripts
Only a few scripts are used in the developer docs, while the repository contains several more with now-unclear purpose. This issue gathers info on them.
Test scripts
Are they needed after dev kits shipped?
-
./test_scripts/l5dvk-test-log.sh
- general test? -
./test_scripts/test_gpio_keys.py
- Test if we have a evdev named 'gpio-keys' -
./test_scripts/test_usb_hub.py
- checks for 14cd:8601 USB device presence ./test_scripts/piano2.wav -
./test_scripts/monitor.sh
- periodically reports temperature -
./test_scripts/test_battery_charger.py
- test_battery_charger, but what does thehealth
value actually mean? -
./test_scripts/fb-color.py
- Check framebuffer by filling the screen with a single color -
./test_scripts/test_panel_brightness.py
- Check if current panel brighness is in [0..9] -
./test_scripts/flash_rsi.sh
- flashes Redpine firmware from/usr/src/rsi_firmware.tar.gz
-
./test_scripts/test_gyro.py
- tests iflsm9ds1_gyro
device exists -
./test_scripts/librem5-devkit-check
- runs all.py
files from this dir after installation
Scripts
-
./scripts/create_tarball.sh
- builds a rootfs? Is this redundant with image-builder? -
./scripts/fetch_latest.sh
- downloads test images and u-build, redundant withlibrem5-devkit-flash-image
-
./scripts/build_uuu.sh
- builds uuu, duplicates docs -
./scripts/get_image.sh
- downloads devkit image, redundant withlibrem5-devkit-flash-image
? -
./scripts/librem5-devkit-flash-image
- downloads and flashes. Used by the docs. -
./scripts/create_initramfs.sh
- is it needed? -
./scripts/root.sh
- alters rootfs, redundant with .debs? -
./scripts/extract_kernel.sh
- does some work for out-of-tree module build? maybe belongs in image-builder?
uuu scripts
-
./uuu_scripts/u-boot_flash_librem5-devkit.lst
- flashes u-boot (redundant withlibrem5-devkit-flash-image
) -
./uuu_scripts/uuu.lst
- list of uuu commands -
./uuu_scripts/flash_librem5-devkit-test.lst
- flashes test u-boot and rootfs, redundant -
./uuu_scripts/u-boot_librem5-devkit.lst
- runs u-boot console? -
./uuu_scripts/test_librem5.lst
- unknown -
./uuu_scripts/flash_librem5-devkit.lst
- flashes u-boot and rootfs (redundant withlibrem5-devkit-flash-image
)
I called scripts that I think are candidates for deletion "redundant". Only the ./scripts/librem5-devkit-flash-image
is referenced in the docs.
Please let me know which descriptions are correct, and if you agree with my "redundant" description of files. Then I will take the summaries and describe them somewhere in the README or in the script body.
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information