9725 2016-06-07 21:27:08 +0000 add docstrings to functions in lib/bb/utils.py that are used in meta- files. 2021-01-14 14:17:17 +0000 1 1 7 Build System, Metadata & Runtime BitBake bitbake 2.2 x86 Multiple RESOLVED FIXED NEWCOMER Medium enhancement 3.3 9612 1 brian.avery mshah joshuagloe mshah poky.bs.watcher poky.watcher randy.macleod richard.purdie --- --- No (bug/feature does not impact docs) oldest_to_newest 62727 0 brian.avery 2016-06-07 21:27:08 +0000 a number of functions in lib/bb/utils.py are used throughout the meta*/ recipe and bbclass files. These need docstrings for programmers and so that we have a starting point for actual documentation. Here's a not guaranteed comprehensive list of functions that are missing docstrings: explode_dep_versions explode_versions vercmp* prunedir contains_any 86968 1 randy.macleod 2020-04-09 15:17:34 +0000 Robert, would you like to work on this? 88833 2 mshah 2020-12-30 11:30:08 +0000 @brian @Randy I'll be happy to work on this. I can see other functions as well which don't have docstrings. Should I add it to all remaining functions or anyone have a specific function list? 88862 3 randy.macleod 2021-01-05 00:48:56 +0000 Milan, Thanks. Brian isn't involved in YP currently. I'd say start with a few and see if they get merged and the keep going as you see fit. 88863 4 mshah 2021-01-05 05:18:20 +0000 Thanks, Randy. I'll take the bug and start working. 88864 5 mshah 2021-01-05 06:13:05 +0000 I have gone through both Bug 9725 and Bug 9612 and found a list of functions. Functions that already have a docstring. - contains - lockfile - unlockfile - explode_dep_versions2 - join_deps - explode_deps - mkdirheir - copyfile Functions that need a docstring. - prunedir - explode_dep_versions - vercmp* - contains_any 88907 6 mshah 2021-01-11 13:03:11 +0000 Hi @randy.macleod@windriver.com, Patch is accepted and merged to master branch. Ref: https://git.openembedded.org/bitbake/commit/?id=b61ba4a18693a9e553d2a93161feb0bcc1c82384 I'm marking the bug as resolved now. 88916 7 richard.purdie 2021-01-13 23:27:12 +0000 Looks good, thanks for the help on this! 88922 8 randy.macleod 2021-01-14 14:17:17 +0000 Thanks Milan.