Might be something of interest for you @jia200x and @basilfx

Question (maybe I miss something): what's the benefit of these make targets? IIRC instead of calling make bootstrap-example I could just run riotgen example, right - which is even shorter.

what's the benefit of these make targets?

RIOTBASE is set automatically, so the the question about this parameter is skipped in the cli wizard.

Using riotgen directly, you would need: RIOTBASE=<riot base> riotgen example

I gave it a try, but it doesn't properly escape output for some reason:

basilfx:RIOT_aabadie/ (pr/generator) $ make bootstrap-example
-e -n \033[1;31m"riotgen" command is not available, please
-e -n \033[1;31mconsider installing it from
-e \033[1;31mhttps://pypi.python.org/pypi/riotgen\033[0m
make: *** [riotgen-installed] Error 1

(using zsh on macOS 10.13, normal RIOT-OS errors are colored.)

@aabadie awesome!

Question (maybe I miss something): what's the benefit of these make targets? IIRC instead of calling make bootstrap-example I could just run riotgen example, right - which is even shorter.

In addition, the riotgen script might live in dist/tools. So, a make target could invoke the tool with all required env variables.

the riotgen script might live in dist/tools

I'm not sure it's a good idea. riotgen is not only a script, but several, and it also contains template files. That's why I tried to create a self contained python package: it's easy to install and won't bloat the RIOT code base.

a make target could invoke the tool with all required env variables.

In any case, riotgen will have to be modified to support extra env variables (BOARD?)

I gave it a try, but it doesn't properly escape output for some reason

apparently the color.inc.mk is not working as I expected, I'll look into it. And it's not used somewhere else btw. (yes it is in Makefile.include)

I'm not sure it's a good idea. riotgen is not only a script, but several, and it also contains template files. That's why I tried to create a self contained python package: it's easy to install and won't bloat the RIOT code base.

And maybe cloning from RIOT repo? Probably not a big improvement to have it in dist/tools, but could allow to "bootstrap-%" without worrying about installing external tools :)

I confirm:

• bootstrap-{test, example, board} work, each case as expected (proper files, descriptions are OK, etc)
• riotgen undetected works as expected with colored output

BTW, code looks good to me

@jia200x I updated the makefile to include recents changes in the upstream riot-generator (pkg generator added) and improved the targets : make auto-completion is now supported for the new targets.

any interest for this ?

up

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you want me to ignore this issue, please mark it with the "State: don't stale" label. Thank you for your contributions.

Quite an old one indeed.

Testing it now @aabadie looks quite nice, it seems like it could use an entry in the docs!

Tested all commands inside RIOTBASE and outside RIOTBASE, works fine on linux, I'll test on MAC now.

Tested on MAC as well:

→ make generate-example
Example application name: test
Example application brief description: asdfasd
Target board [native]: 
Required modules (comma separated) []: 
Required packages (comma separated) []: 
Required features (comma separated) []: 
Author name []: Francisco
Author email []: [email protected]
Organization []: Inria
Example 'test' generated in examples/test with success!

@aabadie please correct me if I'm wrong, but as I understand the main benefit to have a make target
is having RIOTBASE set right?

Other I like this tool but I would like it documented somewhere in out doc, maybe in getting started?

@kaspar030 you have some change requests from a while back that @aabadie seems to have answered, are you fine with the changes?

Note: I haven't looked at the python code, but this doesn't seem relevant here, the functionality is what we want here.

Note: I haven't looked at the python code, but this doesn't seem relevant here, the functionality is what we want here.

Can I quote you on that? ;)

Can I quote you on that? ;)

I guess, we are not reviewing external code here. If the project is merged into the organization then we can review it IMO.

I understand the main benefit to have a make target is having RIOTBASE set right?

Yes and the fact that is can bootstrap a skeleton application/pkg/board/test from RIOT itself.

I like this tool but I would like it documented somewhere in out doc, maybe in getting started?

Good idea, I'll push a commit asap.

I haven't looked at the python code, but this doesn't seem relevant here, the functionality is what we want here.

I improved it slightly during the last days: now it uses Jinja2 templating engine to render the files (I should have done that from the start...). There's still room for improvement/refactoring and I'm now in the process of adding tests.

we are not reviewing external code here. If the project is merged into the organization then we can review it IMO.

If the community is OK to maintain such a tool in a separate repository, that would be great indeed.

I would like it documented somewhere in out doc, maybe in getting started?

I can propose something. Is it ok if it's in a follow-up PR ?

The latest version of riotgen is now also able to generate the source code of a driver and of a module. I adapted the PR accordingly.

I can propose something. Is it ok if it's in a follow-up PR ?

If you open it right away :)

If you open it right away :)

(so we can nitpick there, while getting this in)

here is the documentation @fjmolinas => #14103

ACK!

Thank you for the review @fjmolinas !