apache / apache/nuttx

Suggestion: Add "Description:" header to defconfig file

Open
#9,598 3 comments 2 reactions 0 assignees View on GitHub
Type: Improvement
Dominant language
C
Stars
4k
Forks
1.7k
Avg merge
1d 17h
Merged PRs (30d)
237

Description

Currently we use the name of the board profile directory to give some clue to users what is the purpose of that defconfig, i.e.: nsh, usbnsh, netnsh, timer, kostest, etc.

But in some case it is not enough, people familiar to NuttX will know what that kostest does, but for a newcomer it doesn't make much sense.

Also now on ESP32S3 we will have two USB Console options: USB Console using USB-JTAG-SERIAL peripheral (that we will call usbconsole) and USB Console using USB OTG Device (that we will call usbnsh).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.