Hello,
I would like to submit some patches for discussion and for merging, if
agreed upon.
First of them is a simple comment typo fix in AVR DA/DB sources, the
second one is a formatting fix in documentation for High resolution
timer
(https://nuttx.apache.org/docs/latest/reference/os/time_clock.html) My
guess is that the author of the documentation wanted to have the normal
(non-bold) text indented right of the bold text but the result was a
sentence split to two paragraphs. I removed the indentation because I
didn't find an easy method to make the HTML look indented as
(presumably) intended.
The third patch is currently more of a suggestion. It applies to the
Custom Boards How-To
(https://nuttx.apache.org/docs/latest/guides/customboards.html) I tried
to follow this howto when preparing my custom board and had no success
with the guide as is.
For one thing, the guide includes a listing of files (names, actually)
which are supposed to exist in the custom board directory tree but it
does not specify which of them are directories. That was relatively easy
to solve by looking into a directory tree of a different (in-tree) board
so my patch does not change this.
The worst issue was that the guide does not mention anything about a
defconfig file while the configure script expects that file to exist in
the directory given to it. This file is not supposed to be edited
manually but it is also not possible to create it using savedefconfig
because that only works when configure succeeds. The user is stuck in a
chicken-or-the-egg situation.
In an attempt to solve this, I tried to create an empty file but that
caused the configure script to fail even worse. It is creating some
symlinks in the directory tree and it is using paths specified in the
defconfig file for that. Empty file - no paths, the source tree was left
in a broken state - configure refused to run anymore but distclean
failed because of the broken symlinks. Manual cleanup was required.
My patch adds a workaround to this and shows an example of minimal
defconfig file. Again, it is posted as a suggestion as I don't know if
this is actually proper solution. It's just a solution that worked for
me. Additionally, it may be better to provide different example for an
architecture that is more common.
As usual - I do not have a GitHub account so - if the patches seem
useful - I would like to ask someone with one to create a pull request.
The series is available in a git repository nuttx.git at git.kerogit.eu
accessible through HTTP/S. (Trying to prevent bot traffic by not posting
the URL in machine-readable form.) The relevant branch is called
doc_fixes_20260228.
Any comments or suggestions are welcome.
