I have walked through the custom apps guide from the cwiki and find that it is
explaining how to replace the ENTIRE Nuttx Apps directory with a custom
alternative.
That seems to me to be perhaps of minority interest but I'll include it in the
documentation I'm writing anyway for completeness.
But is there a way to add a custom folder - in or out of tree - that will be
included along with the built-in apps and examples? This would allow you to
include custom appss, and the built-in ones, but not have a problem when
merging future releases that might cause the building in of the custom apps to
fail?
Perhaps I'm over thinking it?
On 07/10/2022, 17:25, "TimH" <t...@jti.uk.com.INVALID> wrote:
Got it - thanks Nathan. I will probably plunder some text from the cwiki
then, and not feel guilty :-)
>-----Original Message-----
>From: Nathan Hartman <hartman.nat...@gmail.com>
>Sent: 07 October 2022 17:23
>To: dev@nuttx.apache.org
>Subject: Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for
>custom out-of-tree boards (PR #7103)
>
>On Fri, Oct 7, 2022 at 11:59 AM TimH <t...@jti.uk.com.invalid> wrote:
>>
>> As per request below, I’m happy to add a paragraph or two regarding this,
>but I am not sure where it should go?
>>
>> It could be a section in “guides” or I could add it to the FAQ. What is
>preferred, assuming the Documentation folder in the repo is actually the
right
>place for this of course?
>
>I think it would best fit in guides under the Documentation folder in the
repo,
>and I think that's where all "official" documentation should ultimately be.
>
>> Related to this, what is the significance of the cwiki
>(https://cwiki.apache.org/confluence/display/NUTTX) as that has a lot more
>information in it compared to the Nuttx distro’s Documentation folder, but
is
>outdated and perhaps not maintained I think? The cwiki has information on
>custom app directory usage that could either be a source of info for a more
>complete “custom environment” guide or is the actually the intended place
>for the custom boards info I’ve been asked to add?
>
>From my memory, before NuttX joined the Apache.org Incubator, what's now
>in the CWIKI was in a MediaWiki on the NuttX website. When we joined the
>Incubator, this was somehow migrated to the Apache.org CWIKI. Some (or
>most?) of it was then migrated again into what is now the Documentation
>folder in the repo. However, there are some differences between the two
>because new documentation has been written under Documentation while
>some of the docs available in the CWIKI may not have been migrated, and I
>think there are still articles in the CWIKI that have not made it into
>Documentation.
>
>As to what's the purpose of the CWIKI: Some time ago, I asked whether we
>should keep the CWIKI around. Now I can't seem to locate that email after a
>quick search, but as I remember, a few people said they would like to keep
>the CWIKI as a place to collaborate on documentation, as it makes real-time
>collaborative writing easier (without the added friction of making PRs) and
>then migrate finished documents into Documentation.
>
>In short, there's some work yet to be done on documentation and it isn't a
>secret that we, like probably most community-driven projects, need lots of
>help improving our documentation!!!
>
>Hope that helps. I'd like to say a sincere THANK YOU for any improvements
>you're willing to make, large or small!
>
>Cheers,
>Nathan
