Matteo,
Will do. Submitted pull request in nuttx repo, will look to put one
together for DOcumentation.
On 2/18/26 14:52, Matteo Golin wrote:
Hi Peter!
On the docs website (RST files under Documentation/) there are
descriptions for each board's defconfigs under the "Configurations"
header. That would be a good place to put it!
Matteo
On Wed, Feb 18, 2026, 2:02 PM Alan C. Assis <[email protected]> wrote:
Hi Peter,
Actually we try to avoid adding README files in the repository,
maybe an
alternative should have a description header in the Defconfig itself,
something like this:
# Description: This defconfig will be used to demonstrate how to use
buttons on the board.
# The buttons used on this board are P1 and P2.
#
# This file is autogenerated: PLEASE DO NOT EDIT IT.
#
# You can use "make menuconfig" to make any modifications to the
installed
.config file.
# You can then do "make savedefconfig" to generate a new defconfig
file
that includes your
# modifications.
#
But we need to modify the "make defconfig" to allow the user to
enter a
Description.
Also it needs to show the original Description from a saved
defconfig when
the user just wants to fix some small errors and doesn't want to
modify it.
I think it is a good idea, let's see what other contributors here
think
about it.
BR,
Alan
On Wed, Feb 18, 2026 at 3:44 PM Peter Barada
<[email protected]> wrote:
> Alan,
>
> Makes sense; will do.
>
> Another question. Is it worth adding a README into the directory
> containing the defconfig that (succinctly) explains what the
defconfig
> is trying to do (especially if the defconfig does multiple things or
> expects hardware connected to the development board)?
>
> On 2/18/26 13:20, Alan C. Assis wrote:
> > Hi Peter,
> > The nsh should be as simple as possible, without any
peripherals other
> than
> > the minimum to get nsh working.
> >
> > Unfortunately, there are many configs that don't follow this
rule, enter
> > inside nuttx/boards and run:
> >
> > $ git grep CONFIG_INPUT_BUTTONS | grep defconfig
> >
> > Suggestion, instead naming it btnnsh use the name "buttons"
like those
> > esp32 boards are doing.
> >
> > BR,
> >
> > Alan
> >
> >
> > On Wed, Feb 18, 2026 at 2:23 PM Peter Barada
<[email protected]>
> wrote:
> >
> >> To bring myself up to speed on contributing to Nuttx, I'm
adding button
> >> support to the Nucleo-h743zi2 board, while testing on a
nucleo-h753zi2
> >> board - same MB1364 board design as nucleo-h743zi2).
> >>
> >> My question is whether to extend nucleo-h743zi2:nsh
defconfig, or should
> >> I create a new nucleo-h743zi2:btnnsh defconfig.
> >>
> >> Once I know which is preferred I'll generate a pull request...
> >>
> >> Thanks in advance!
> >>
> >> --
> >> Peter Barada
> >> [email protected]
> >>
> >>
> --
> Peter Barada
> [email protected]
>
>
--
Peter Barada
[email protected]
