On Sat, Jun 24, 2023 at 3:53 PM Alan C. Assis wrote: > Dear NuttXers, > As some people here know, recently Espressif added support for USB OTG > Device on ESP32S3 (thanks to Dong Heng).
BIG TANKS!! :-) > And it opened the possibility to have USB Console using this USB OTG > Device or using the USB_SERIAL_JTAG (see TRM: "33 USB Serial/JTAG > Controller (USB_SERIAL_JTAG)" ). > > So, to "avoid" confusion we will follow this convention: usbconsole > when referring to USB console using USB_SERIAL_JTAG and usbnsh when > referring to USB console using USB Device. > > However for a newcomer who never saw his email, it will be difficult > to understand what each one does. Same apply to many board profiles we > already have currently. The defconfig name should and can be self-explanatory: 1. usbconsole when referring to USB console using USB_SERIAL_JTAG is not self-explanatory. Why not just use usbnshespserialjtag? I know it looks ugly (can be usbnsh_esp_serialjtag?) but its grepable and most times it is copied / typed only once? :-) 2. usbnsh when referring to USB console using USB Device... as for other devices so there is no confusion. > Of course, the best way to solve it is creating a documentation for > each board profile, but it is something that doesn't happen easily. Just let me know what to put and where and I will help with updating the documentation.. lets keep things coherent and make folks used to the process :-) > So, I think having a "Description: " in the defconfig could help here. > People could read it to know what it does or we could use: > "./tools/configure.sh info boardname:profile" to print this information. I like the idea! It would be nice to have "Description" field within the "Defconfig" itself, that would create self-explanatory solution right at the code and on the `-L` list :-) Right now some options are obvious only for people who already know them and this is not the way.. for instance some CONFIG options also could be more verbose :-) > This is just a RFC, I opened it here: > https://github.com/apache/nuttx/issues/9598 My comments inside too :-) -- CeDeROM, SQ7MHZ, http://www.tomek.cedro.info
