14235 2021-02-15 20:23:23 +0000 bbclass file name convention is not consistent wrt dash and underscore ( - _ ) 2024-05-23 15:22:41 +0000 1 1 7 Build System, Metadata & Runtime OE-Core oe-core other 3.3 All Multiple RESOLVED WORKSFORME NEWCOMER Medium enhancement 5.0 1 randy.macleod sgw open.source richard.purdie sgw --- --- Yes (doc changes required) oldest_to_newest 89267 0 randy.macleod 2021-02-15 20:23:23 +0000 ls meta/classes/*_* meta/classes/bin_package.bbclass meta/classes/lib_package.bbclass meta/classes/package_rpm.bbclass meta/classes/rm_work.bbclass ... $ ls meta/classes/*-* meta/classes/autotools-brokensep.bbclass meta/classes/go-mod.bbclass meta/classes/kernel-devicetree.bbclass meta/classes/remove-libtool.bbclass meta/classes/baremetal-image.bbclass meta/classes/go-ptest.bbclass meta/classes/kernel-fitimage.bbclass meta/classes/report-error.bbclass Should we wrap the files witn an underscopre, issue a warning for a release or two and then make the evil _ files be an error at some point? 89268 1 randy.macleod 2021-02-15 20:24:18 +0000 $ ls meta/classes/*-* | wc -l 68 $ ls meta/classes/*_* | wc -l 38 dashes win! 89293 2 randy.macleod 2021-02-18 15:40:44 +0000 We should improve usability by: 1. Check export functions for dashes 2. Check for shell function names with dashes 3. Create a list of known classes and error if not in that list and contains a dash 4. We could do pattern matching on names that are not found. Some of these things can be done by a NEWCOMER, Please comment on this bug if you are going to work on it. 89333 3 open.source 2021-02-20 20:21:13 +0000 I would happily work on this one. Is there a decision on how to handle the issue? 89450 4 randy.macleod 2021-03-01 01:57:57 +0000 Oleksandr, Richard wanted to do this incrementally and certainly not do a mass renaming. Perhaps the best way to get started is to implement: 3. Create a list of known classes and error if not in that list and contains a dash 4. We could do pattern matching on names that are not found. I think that 4. starts as a warning and becomes an error in a future release. 97160 5 randy.macleod 2023-10-30 15:37:33 +0000 Build move to 5.0 -- ../Randy 97760 6 sgw 2024-01-09 01:39:19 +0000 Proof of concept scripts attached it uses tinfoil to scan the BBCLASS path and find bbclasses then searches for unknwon bbclasses that contains "_" in filename. It also checks existing bbclasses for '-' in either addtask or EXPORT_FUNCTIONS directives. /poky$ scripts/check-bbclasses Loading cache: 100% |#################################################| Time: 0:00:00 Loaded 1927 entries from dependency cache. Warning: BBClass file name contains '_': poky/meta/classes/bad_bbclass.bbclass Warning: addtask contains '-': /poky/meta/classes/bad_bbclass.bbclass: addtask do-bad-task Warning: EXPORT_FUNCTIONS contains '-': /poky/meta/classes/bad_bbclass.bbclass: EXPORT_FUNCTIONS do-bad-function 97761 7 5003 sgw 2024-01-09 01:40:33 +0000 Created attachment 5003 Prototype script 97762 8 5004 sgw 2024-01-09 01:41:15 +0000 Created attachment 5004 test bbclass 98121 9 sgw 2024-02-02 20:14:18 +0000 Due to the combination of '-' and shell function, we can not use '-' in bbclass file names, so instead it should be _, which just means more change over time. ERROR: The classname dash-bbclass contains a dash character and is calling an sh function dash-bbclass_do_dash_shell_function using EXPORT_FUNCTIONS. Since a dash is illegal in sh function names, this cannot work, please rename the class or don't use EXPORT_FUNCTIONS. ERROR: Unable to parse /home/swold/src/yocto/poky/bitbake/lib/bb/__init__.py 98122 10 randy.macleod 2024-02-02 20:29:13 +0000 Saul, Thanks for looking into this bug which aims at making the class file names follow a pattern. I'm fine with picking "_" rather than "-" due to shell restrictions. 98177 11 richard.purdie 2024-02-09 14:57:09 +0000 As you've found, dashes give problems with shell and function names so underscores are preferred when used in class names. Users to tend to prefer dashes though. I added the error to export functions a while back as a compromise around this issue, to ensure people know in the cases things really break. I'm torn on all this to be honest, not sure what the best thing to do is. 99060 12 randy.macleod 2024-05-23 15:06:50 +0000 Since we have limits to how consistent things can be we are closing this bug and if people are working on one of the files that can be renamed, they can do so. -- YP bug review (Randy) 99068 13 randy.macleod 2024-05-23 15:22:41 +0000 moving back to 5.0 since we aren't going to be doing a mass change. 5003 2024-01-09 01:40:33 +0000 2024-01-09 01:40:33 +0000 Prototype script check-bbclasses text/x-python3 3383 sgw IyEvdXNyL2Jpbi9lbnYgcHl0aG9uMwojCiMgQ29weXJpZ2h0IE9wZW5FbWJlZGRlZCBDb250cmli dXRvcnMKIwojIFNQRFgtTGljZW5zZS1JZGVudGlmaWVyOiBHUEwtMi4wLW9ubHkKIwoKaW1wb3J0 IHN5cywgb3MsIHN1YnByb2Nlc3MsIHJlLCBzaHV0aWwKCmtub3duX2NsYXNzZXMgPSAoCgkidGVz dF9ldmVudHMuYmJjbGFzcyIsCgkibWlncmF0ZV9sb2NhbGNvdW50LmJiY2xhc3MiLAoJImNvcHls ZWZ0X2NvbXBsaWFuY2UuYmJjbGFzcyIsCgkic2lnbl9pcGsuYmJjbGFzcyIsCgkibXVsdGlsaWJf Z2xvYmFsLmJiY2xhc3MiLAoJInVzZXJhZGRfYmFzZS5iYmNsYXNzIiwKCSJybV93b3JrX2FuZF9k b3dubG9hZHMuYmJjbGFzcyIsCgkic2lnbl9ycG0uYmJjbGFzcyIsCgkicm1fd29yay5iYmNsYXNz IiwKCSJzaWduX3BhY2thZ2VfZmVlZC5iYmNsYXNzIiwKCSJjb3B5bGVmdF9maWx0ZXIuYmJjbGFz cyIsCgkicmVsYXRpdmVfc3ltbGlua3MuYmJjbGFzcyIsCgkicmVjaXBlX3Nhbml0eS5iYmNsYXNz IiwKCSJtZXRhZGF0YV9zY20uYmJjbGFzcyIsCgkicHl0aG9uX3B5bzMuYmJjbGFzcyIsCgkibXVs dGlsaWJfc2NyaXB0LmJiY2xhc3MiLAoJIm11bHRpbGliX2hlYWRlci5iYmNsYXNzIiwKCSJjb21w cmVzc19kb2MuYmJjbGFzcyIsCgkicG9wdWxhdGVfc2RrLmJiY2xhc3MiLAoJImxpY2Vuc2VfaW1h Z2UuYmJjbGFzcyIsCgkicHl0aG9uX21hdHVyaW4uYmJjbGFzcyIsCgkicHl0aG9uX3NldHVwdG9v bHMzX3J1c3QuYmJjbGFzcyIsCgkiaW1hZ2VfdHlwZXMuYmJjbGFzcyIsCgkiY2FyZ29fYy5iYmNs YXNzIiwKCSJiaW5fcGFja2FnZS5iYmNsYXNzIiwKCSJweXRob25fcG9ldHJ5X2NvcmUuYmJjbGFz cyIsCgkiZGlzdHJvX2ZlYXR1cmVzX2NoZWNrLmJiY2xhc3MiLAoJImxpYl9wYWNrYWdlLmJiY2xh c3MiLAoJInB5dGhvbl9zZXR1cHRvb2xzX2J1aWxkX21ldGEuYmJjbGFzcyIsCgkicG9wdWxhdGVf c2RrX2Jhc2UuYmJjbGFzcyIsCgkiZmVhdHVyZXNfY2hlY2suYmJjbGFzcyIsCgkicHl0aG9uX3Bl cDUxNy5iYmNsYXNzIiwKCSJjYXJnb19jb21tb24uYmJjbGFzcyIsCgkicG9wdWxhdGVfc2RrX2V4 dC5iYmNsYXNzIiwKCSJyb290ZnNfaXBrLmJiY2xhc3MiLAoJInJvb3Rmc19kZWIuYmJjbGFzcyIs CgkiY3Bhbl9idWlsZC5iYmNsYXNzIiwKCSJyb290ZnNfcnBtLmJiY2xhc3MiLAoJInB5dGhvbl9m bGl0X2NvcmUuYmJjbGFzcyIsCgkicHl0aG9uX2hhdGNobGluZy5iYmNsYXNzIiwKCSJpbWFnZV90 eXBlc193aWMuYmJjbGFzcyIsCgkic2V0dXB0b29sczNfbGVnYWN5LmJiY2xhc3MiLAoJInBhY2th Z2VfcnBtLmJiY2xhc3MiLAoJInBhY2thZ2VfZGViLmJiY2xhc3MiLAoJInBhY2thZ2VfaXBrLmJi Y2xhc3MiLAoJInBhY2thZ2VfcGtnZGF0YS5iYmNsYXNzIgopCgpkZWYgaXNfYWxsb3dlZChjKToK IyAgICBmb3Iga25vd24gaW4ga25vd25fY2xhc3NlczoKIyAgICAgICAgaWYgIGluIHM6CiMgICAg ICAgICAgICByZXR1cm4gVHJ1ZQogICAgcmV0dXJuIEZhbHNlCgpkZWYgZ2V0X3RpbmZvaWwoKToK ICAgIHNjcmlwdHNfcGF0aCA9IG9zLnBhdGguZGlybmFtZShvcy5wYXRoLnJlYWxwYXRoKF9fZmls ZV9fKSkKICAgIGxpYl9wYXRoID0gc2NyaXB0c19wYXRoICsgJy9saWInCiAgICBzeXMucGF0aCA9 IHN5cy5wYXRoICsgW2xpYl9wYXRoXQogICAgaW1wb3J0IHNjcmlwdHBhdGgKICAgIHNjcmlwdHBh dGguYWRkX2JpdGJha2VfbGliX3BhdGgoKQogICAgaW1wb3J0IGJiLnRpbmZvaWwKICAgIHRpbmZv aWwgPSBiYi50aW5mb2lsLlRpbmZvaWwoKQogICAgIyB0aW5mb2lsLnByZXBhcmUoY29uZmlnX29u bHk9RmFsc2UpCiAgICB0aW5mb2lsLnByZXBhcmUoKQogICAgIyB0aW5mb2lsLmxvZ2dlci5zZXRM ZXZlbChsb2dnaW5nLldBUk5JTkcpCiAgICByZXR1cm4gdGluZm9pbAoKaWYgX19uYW1lX189PSdf X21haW5fXyc6CiAgICBpbXBvcnQgYXJncGFyc2UsIHNodXRpbAoKICAgIHBhcnNlciA9IGFyZ3Bh cnNlLkFyZ3VtZW50UGFyc2VyKGRlc2NyaXB0aW9uPSdTYW5pdHkgY2hlY2tlciBmb3IgYmJjbGFz c2VzJykKICAgIHBhcnNlci5hZGRfYXJndW1lbnQoIi0tdmVyYm9zZSIsIGRlZmF1bHQ9RmFsc2Us IGFjdGlvbj0ic3RvcmVfdHJ1ZSIpCiAgICBhcmdzID0gcGFyc2VyLnBhcnNlX2FyZ3MoKQoKICAg IHRpbmZvaWwgPSBnZXRfdGluZm9pbCgpCgogICAgYmJwYXRoID0gdGluZm9pbC5jb25maWdfZGF0 YS5nZXRWYXIoJ0JCUEFUSCcpLnNwbGl0KCc6JykKICAgIGZvciBwYXRoIGluIGJicGF0aDoKICAg ICAgICB3aXRoIG9zLnNjYW5kaXIocGF0aCkgYXMgaXQ6CiAgICAgICAgICAgIGZvciBlbnRyeSBp biBpdDoKICAgICAgICAgICAgICAgIGlmICJjbGFzc2VzIiBpbiBlbnRyeS5uYW1lIGFuZCBlbnRy eS5pc19kaXIoKToKICAgICAgICAgICAgICAgICAgICB3aXRoIG9zLnNjYW5kaXIocGF0aCArICIv IiArIGVudHJ5Lm5hbWUpIGFzIGNsYXNzZXM6CiAgICAgICAgICAgICAgICAgICAgICAgIGZvciBj IGluIGNsYXNzZXM6CiAgICAgICAgICAgICAgICAgICAgICAgICAgICBpZiBjLm5hbWUuZW5kc3dp dGgoIi5iYmNsYXNzIikgYW5kICJfIiBpbiBjLm5hbWUgYW5kIG5vdCBjLm5hbWUgaW4ga25vd25f Y2xhc3NlczoKCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgcHJpbnQoIldhcm5pbmc6 IEJCQ2xhc3MgZmlsZSBuYW1lIGNvbnRhaW5zICdfJzogIiArIHBhdGggKyAiLyIgKyBlbnRyeS5u YW1lICsgIi8iICsgYy5uYW1lKQogICAgICAgICAgICAgICAgICAgICAgICAgICAgd2l0aCBvcGVu KHBhdGggKyAiLyIgKyBlbnRyeS5uYW1lICsgIi8iICsgYy5uYW1lKSBhcyBmOgogICAgICAgICAg ICAgICAgICAgICAgICAgICAgICAgIGZvciBsaW5lIGluIGYucmVhZGxpbmVzKCk6CiAgICAgICAg ICAgICAgICAgICAgICAgICAgICAgICAgICAgIGlmIGxpbmUuc3RhcnRzd2l0aCgiYWRkdGFzayAi KSBhbmQgIi0iIGluIGxpbmU6CiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg ICBwcmludCgiV2FybmluZzogYWRkdGFzayBjb250YWlucyAnLSc6ICIgKyBwYXRoICsgIi8iICsg ZW50cnkubmFtZSArICIvIiArIGMubmFtZSArICI6ICIgKyBsaW5lKQogICAgICAgICAgICAgICAg ICAgICAgICAgICAgICAgICAgICBpZiBsaW5lLnN0YXJ0c3dpdGgoIkVYUE9SVF9GVU5DVElPTlMg IikgYW5kICItIiBpbiBsaW5lOgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg ICAgcHJpbnQoIldhcm5pbmc6IEVYUE9SVF9GVU5DVElPTlMgY29udGFpbnMgJy0nOiAiICsgcGF0 aCArICIvIiArIGVudHJ5Lm5hbWUgKyAiLyIgKyBjLm5hbWUgKyAiOiAiICsgbGluZSkKCgoKICAg IHRpbmZvaWwuc2h1dGRvd24oKQo= 5004 2024-01-09 01:41:15 +0000 2024-01-09 01:41:15 +0000 test bbclass bad_bbclass.bbclass text/plain 54 sgw YWRkdGFzayBkby1iYWQtdGFzawoKRVhQT1JUX0ZVTkNUSU9OUyBkby1iYWQtZnVuY3Rpb24K