analogdevicesinc / lnxdsp-adi-meta

Yocto meta layer for Analog Devices ADSP-SC5xx based EZ-KIT boards
Other
15 stars 10 forks source link

Lnxdsp 928/remove scripts dependency #51

Closed vasbimpikasadi closed 8 months ago

vasbimpikasadi commented 8 months ago

Changes

This completely removes the need to maintain lxndsp-scripts repo any further.

Under the new directory tools, the setup-environment script from the soon-to-be-defunct repo has been copied over. It is modified to get the sample local.conf file gained by yocto when oe-init-build-env is ran, and modified it in 3 stages:

  1. Add copyright notice, with current year add_copyright_notice()
  2. Add the horizontal sc5xx edits/additions sc5xx_universal_edit(). These were identified after doing a 6-way diff between the platforms that we'll support going forward:
    • sc573-ezkit
    • sc589-mini
    • sc594-som-ez*
    • sc594-som-ez*

image

  1. Add per board changes (ln 252). Group them where possible

Benefits

This results in the same files that are canned in lnxdsp-scripts and can be easily modified. I think having one less repo to maintain and hand-edit yet another conf file, brings the maintenance cost way down.

The biggest benefit however, is including all the changes needed to build in our own meta-layer, instead of more repos. That will come very handy with the continuous efforts of aligning with upstream code/practices.

Testing

Building with the changes produced no problems in Jenkins: https://www.secad.analog.com/jenkins/dte/job/Linux-ADSP-SC5xx/job/ADSP-SC5xx-builder/ builds #517 through to #543

davidgibsonadi commented 8 months ago

What is the implication here for any customer that has an existing check-out, upgrades and attempts to run their existing scripts/* programs? Is there anything more than a Release Note "Please remove scripts" that we can do to avoid problems?

vasbimpikasadi commented 8 months ago

@davidgibsonadi zero implications. The scripts repo isn't going anywhere and nothing needs to be done for builds that aren't using it, as the .xml will be adjusted to accommodate its removal. One wouldn't even notice a change if they hadn't seen the PR.