Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: confusing duplication for Kconfig in custom app #12002

Closed
sumpfralle opened this issue Mar 26, 2024 · 7 comments · Fixed by #12052
Closed

docs: confusing duplication for Kconfig in custom app #12002

sumpfralle opened this issue Mar 26, 2024 · 7 comments · Fixed by #12052

Comments

@sumpfralle
Copy link

Source: https://github.com/apache/nuttx/blob/master/Documentation/guides/customapps.rst#12-kconfig

The above section contains the following text:

In the minimum case, Kconfig is only:

    .. code-block:: console
      # For a description of the syntax of this configuration file,
      # see the file kconfig-language.txt in the NuttX tools repository.
      #
or

    .. code-block:: console
      # For a description of the syntax of this configuration file,
      # see the file kconfig-language.txt in the NuttX tools repository.
      #

The above looks like an accidental copy of the same text.

Probably the author intended to provide a hint for some other kind of minimal usage?

@simbit18
Copy link
Contributor

I think it is an accidental text copy of the old documentation Custom Application Directories

@xiaoxiang781216
Copy link
Contributor

@sumpfralle could you provide a patch to fix it.

@sumpfralle
Copy link
Author

sumpfralle commented Mar 27, 2024

@sumpfralle could you provide a patch to fix it.

I would certainly do this. But I am afraid, that I do not know, which alternative Kconfig content the author had in mind.
The above link to the old wiki content contained only the currently duplicated text.

Of course I could just submit a PR, which removes the duplicate text. Should I do that?

@xiaoxiang781216
Copy link
Contributor

Yes, I think so.

@acassis
Copy link
Contributor

acassis commented Mar 31, 2024

@sumpfralle looking the original Custom Application Directories as @simbit18 pointed it seems like @TimJTi was trying to include two options for that minimum Kconfig. Although the original article said that the Kconfig doesn't need to have any meaning text, I think it is not true. Normally the Kconfig should have an entry with the symbol of the application config, a user friend name/text that will be presented at menuconfig and a help text with information about that application.

@TimJTi
Copy link
Contributor

TimJTi commented Mar 31, 2024

I will revisit this documentation - I added it after I found it very difficult myself to set up custom apps and custom boards but looks Like I made some errors. Sorry!

It will be a week or two before I will have the time, but I would be happy to do this.

@TimJTi
Copy link
Contributor

TimJTi commented Apr 4, 2024

PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants