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

Fix Kconfig style #15671

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Fix Kconfig style #15671

merged 1 commit into from
Jan 23, 2025

Conversation

simbit18
Copy link
Contributor

Summary

Remove spaces from Kconfig files
Add TABs

Impact

none

Testing

Remove spaces from Kconfig files
Add TABs
@github-actions github-actions bot added Area: Memory Management Memory Management issues Area: Sensors Sensors issues Board: arm Size: S The size of the change in this PR is small labels Jan 23, 2025
@nuttxpr
Copy link

nuttxpr commented Jan 23, 2025

[Experimental Bot, please feedback here]

No, this PR does not fully meet the NuttX requirements. While it provides a summary of the what, it lacks crucial details about why these changes are necessary. The impact section is too brief and doesn't address all the points required. Critically, there is no testing information provided whatsoever.

Here's a breakdown of what's missing:

  • Summary: Needs to explain the rationale behind removing spaces and adding tabs. Are these changes for stylistic consistency? Do they fix a bug? Improve readability? A related issue number would also be helpful if one exists.
  • Impact: While the changes might seem minor, it's important to explicitly state "NO" for each impact category (or "YES" if applicable and explain). Simply writing "none" is insufficient. For example:
    • Impact on user: NO
    • Impact on build: NO (assuming no changes to the build process itself)
    • Impact on hardware: NO
    • Impact on documentation: Possibly YES if coding style guidelines are updated.
    • Impact on security: NO
    • Impact on compatibility: NO (unless the change affects how Kconfig files are parsed by older tools)
  • Testing: Completely missing. Needs to specify the host and target environments where the changes were tested. Must include logs demonstrating the behavior before and after the change. Even for seemingly trivial changes, demonstrating that the build still works and the configuration system behaves as expected is essential.

Without these details, it's difficult to properly review the PR and assess its suitability for inclusion in NuttX.

@xiaoxiang781216
Copy link
Contributor

@simbit18 do we have any tool checking Kconfig style issue before merging?

@simbit18
Copy link
Contributor Author

Hi @xiaoxiang781216 unfortunately, no !!!
I use on Windows simple Notepad++ editor.
https://notepad-plus-plus.org/

@simbit18
Copy link
Contributor Author

@xiaoxiang781216 the sim/citest build is broken

====================================================================================
Configuration/Tool: sim/citest
2025-01-23 13:27:06
------------------------------------------------------------------------------------


=================================== FAILURES ===================================
___________________________________ test_mm ____________________________________

p = <utils.common.connectNuttx object at 0x7fa7d181db10>

    def test_mm(p):
        if p.board in do_not_support:
            pytest.skip("unsupported at {}".format(p.board))
        ret = p.sendCommand("mm", "TEST COMPLETE", timeout=120)
>       assert ret == 0
E       assert -1 == 0
E         +-1
E         -0

/github/workspace/sources/nuttx/tools/ci/testrun/script/test_os/test_os.py:45: AssertionError
----------------------------- Captured stdout call -----------------------------
+------------------------------------------- Catch Exception -------------------------------------------+
+----------------------------------------------- Result ------------------------------------------------+
| Command     : 'mm'                                                                                    |
| Expect value: ['TEST COMPLETE']                                                                       |
| Timeout     : 120s                                                                                    |
| Test result : Timeout                                                                                 |
+-------------------------------------------------------------------------------------------------------+
- generated json report: /github/workspace/sources/nuttx/boards/sim/sim/sim/configs/citest/logs/sim/sim/pytest.json -
=========================== short test summary info ============================
FAILED test_os/test_os.py::test_mm - assert -1 == 0
=========== 1 failed, 1057 passed, 10 skipped in 2899.46s (0:48:19) ============
  [1/1] Normalize sim/citest
144d143
< CONFIG_TESTING_LTP=y
145a145
> CONFIG_TESTING_LTP=y
Saving the new configuration file
HEAD detached at pull/15671/merge
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   boards/sim/sim/sim/configs/citest/defconfig

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	boards/sim/sim/sim/configs/citest/logs/

no changes added to commit (use "git add" and/or "git commit -a")
====================================================================================

@xiaoxiang781216
Copy link
Contributor

@txy-21 please fix the break as soon as possible.

@xiaoxiang781216
Copy link
Contributor

Before @txy-21 fix the problem, let's merge your trivial change.

@xiaoxiang781216 xiaoxiang781216 merged commit 5c02379 into apache:master Jan 23, 2025
20 of 39 checks passed
@xiaoxiang781216
Copy link
Contributor

@simbit18 fixed here: #15674.

@simbit18 simbit18 deleted the simbit18-kconfig branch January 24, 2025 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Memory Management Memory Management issues Area: Sensors Sensors issues Board: arm Size: S The size of the change in this PR is small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants