forked from RobertCNelson/bb.org-overlays
-
Notifications
You must be signed in to change notification settings - Fork 178
Open
Description
Summary
The Makefile and some documentation reference building config-pin from ./tools/pmunts_muntsos/config-pin.c (e.g., gcc -o config-pin ./tools/pmunts_muntsos/config-pin.c), but config-pin.c is not included in the repository by default. The repo provides tools/pmunts_muntsos/grab_latest.sh which fetches config-pin.c from upstream, but this fetch step is not mentioned in the Makefile or in the docs that show the gcc command.
Why this is an issue
- Users following the docs (e.g.,
books/beaglebone-cookbook/06iot/iot.rst) might run thegcccommand and fail becauseconfig-pin.cis absent. - A short note or minor automation would remove confusion and make the build/docs reproducible without trial-and-error.
Repro steps
- Clone this repo.
- Try
gcc -o config-pin ./tools/pmunts_muntsos/config-pin.cas suggested bybooks/beaglebone-cookbook/06iot/iot.rst. - Observe that
tools/pmunts_muntsos/config-pin.cdoes not exist until you runtools/pmunts_muntsos/grab_latest.shwhich fetches it from upstream.
Suggested fixes
- Add a short README in
tools/pmunts_muntsos/README.mdexplaining how to rungrab_latest.shto obtainconfig-pin.c, or - Update the Makefile to call
grab_latest.shautomatically when attempting to buildconfig-pin, or - Update the docs (e.g.,
books/beaglebone-cookbook/06iot/iot.rst) to show the fetch step before thegcccommand.
Notes
- This is a docs/build reproducibility issue that does not require hardware to verify. I'm happy to open a small PR that updates the docs and/or adds the README explaining the fetch step if maintainers agree.
Metadata
Metadata
Assignees
Labels
No labels