11KConfig Editor
22==============
33
4+ :link_to_translation: `zh_CN:[中文] `
5+
46The KConfig Editor provides enhanced editing capabilities for ESP-IDF configuration files, including syntax highlighting, content assist, and intelligent editing features. It supports all KConfig file types used in ESP-IDF projects.
57
68Supported File Types
79--------------------
810
911The KConfig Editor automatically recognizes and provides enhanced editing for the following file types:
1012
11- - ``Kconfig `` - Main configuration files
12- - ``Kconfig.projbuild `` - Project-specific configuration files
13+ - ``Kconfig `` – Main configuration files
14+ - ``Kconfig.projbuild `` – Project-specific configuration files
1315
1416Features
1517--------
@@ -19,30 +21,30 @@ Syntax Highlighting
1921
2022The editor provides comprehensive syntax highlighting for all KConfig language constructs:
2123
22- - **Keywords **: ``config ``, ``menuconfig ``, ``choice ``, ``menu ``, ``endmenu ``, ``endchoice ``
23- - **Types **: ``bool ``, ``tristate ``, ``string ``, ``hex ``, ``int ``
24- - **Properties **: ``default ``, ``depends ``, ``select ``, ``help ``, ``prompt ``
25- - **Values **: ``y ``, ``n ``, ``m ``, string literals, hexadecimal and integer values
26- - **Comments **: Line comments starting with ``# ``
24+ - **Keywords **: ``config ``, ``menuconfig ``, ``choice ``, ``menu ``, ``endmenu ``, ``endchoice ``.
25+ - **Types **: ``bool ``, ``tristate ``, ``string ``, ``hex ``, ``int ``.
26+ - **Properties **: ``default ``, ``depends ``, ``select ``, ``help ``, ``prompt ``.
27+ - **Values **: ``y ``, ``n ``, ``m ``, string literals, hexadecimal and integer values.
28+ - **Comments **: Line comments starting with ``# ``.
2729
2830Content Assist
2931~~~~~~~~~~~~~~
3032
3133Intelligent content proposals are available when editing KConfig files:
3234
3335- **Main Keywords **: Proposals for ``config ``, ``menuconfig ``, ``choice ``, ``menu ``, etc.
34- - **Types **: Suggestions for ``bool ``, ``tristate ``, ``string ``, ``hex ``, ``int ``
35- - **Properties **: Auto-completion for ``default ``, ``depends ``, ``select ``, ``help ``, ``prompt ``
36- - **Values **: Context-aware suggestions for ``y ``, ``n ``, ``m ``, and string values
36+ - **Types **: Suggestions for ``bool ``, ``tristate ``, ``string ``, ``hex ``, ``int ``.
37+ - **Properties **: Auto-completion for ``default ``, ``depends ``, ``select ``, ``help ``, ``prompt ``.
38+ - **Values **: Context-aware suggestions for ``y ``, ``n ``, ``m ``, and string values.
3739
38- Auto-closing Pairs
40+ Auto-Closing Pairs
3941~~~~~~~~~~~~~~~~~~
4042
4143The editor automatically handles bracket and quote pairing:
4244
43- - **Parentheses **: Automatically closes ``( `` with ``) ``
44- - **Quotes **: Automatically closes ``" `` with ``" ``
45- - **Smart Cursor Positioning **: Cursor stays in the optimal position for continued typing
45+ - **Parentheses **: Automatically closes ``( `` with ``) ``.
46+ - **Quotes **: Automatically closes ``" `` with ``" ``.
47+ - **Smart Cursor Positioning **: Cursor stays in the optimal position for continued typing.
4648
4749Example of auto-closing pairs:
4850
@@ -62,28 +64,28 @@ Smart Indentation
6264
6365The editor provides intelligent indentation rules for KConfig structure:
6466
65- - **Increase Indent **: After ``menu ``, ``config ``, ``menuconfig ``, ``choice ``, ``help ``, ``comment ``
66- - **Decrease Indent **: After ``endmenu ``, ``endchoice ``, ``endif ``
67- - **Consistent Formatting **: Maintains proper KConfig file structure
67+ - **Increase Indent **: After ``menu ``, ``config ``, ``menuconfig ``, ``choice ``, ``help ``, ``comment ``.
68+ - **Decrease Indent **: After ``endmenu ``, ``endchoice ``, ``endif ``.
69+ - **Consistent Formatting **: Maintains proper KConfig file structure.
6870
6971Bracket Matching
7072~~~~~~~~~~~~~~~~
7173
7274Visual highlighting of matching bracket pairs:
7375
74- - **Menu Blocks **: ``menu `` and ``endmenu `` pairs
75- - **Choice Blocks **: ``choice `` and ``endchoice `` pairs
76- - **Parentheses **: ``( `` and ``) `` pairs
77- - **Quotes **: ``" `` and ``" `` pairs
76+ - **Menu Blocks **: ``menu `` and ``endmenu `` pairs.
77+ - **Choice Blocks **: ``choice `` and ``endchoice `` pairs.
78+ - **Parentheses **: ``( `` and ``) `` pairs.
79+ - **Quotes **: ``" `` and ``" `` pairs.
7880
7981Code Folding
8082~~~~~~~~~~~~
8183
8284Support for folding KConfig blocks:
8385
84- - **Menu Sections **: Fold/unfold menu blocks
85- - **Choice Sections **: Fold/unfold choice blocks
86- - **Comment Regions **: Fold/unfold comment sections
86+ - **Menu Sections **: Fold/unfold menu blocks.
87+ - **Choice Sections **: Fold/unfold choice blocks.
88+ - **Comment Regions **: Fold/unfold comment sections.
8789
8890Usage
8991-----
@@ -93,9 +95,9 @@ Opening KConfig Files
9395
9496KConfig files are automatically opened with the enhanced editor when:
9597
96- 1. Double-clicking on any ``Kconfig `` or ``Kconfig.projbuild `` file in the Project Explorer
97- 2. Right-clicking and selecting " Open With > KConfig Editor"
98- 3. Opening files from the File menu
98+ 1. Double-clicking on any ``Kconfig `` or ``Kconfig.projbuild `` file in the Project Explorer.
99+ 2. Right-clicking and selecting `` Open With `` > `` KConfig Editor ``.
100+ 3. Opening files from the `` File `` menu.
99101
100102The editor will automatically detect the file type and apply the appropriate syntax highlighting and features.
101103
@@ -104,10 +106,10 @@ Editing KConfig Files
104106
105107When editing KConfig files, you can take advantage of:
106108
107- - **Content Assist **: Press ``Ctrl+Space `` to trigger content proposals
108- - **Auto-completion **: Type partial keywords and press ``Tab `` to complete
109- - **Bracket Navigation **: Use ``Ctrl+Shift+P `` to jump between matching brackets
110- - **Code Folding **: Click the fold icons in the editor gutter to collapse/expand sections
109+ - **Content Assist **: Press ``Ctrl+Space `` to trigger content proposals.
110+ - **Auto-completion **: Type partial keywords and press ``Tab `` to complete.
111+ - **Bracket Navigation **: Use ``Ctrl+Shift+P `` to jump between matching brackets.
112+ - **Code Folding **: Click the fold icons in the editor gutter to collapse/expand sections.
111113
112114Example KConfig Entry
113115~~~~~~~~~~~~~~~~~~~~~
@@ -141,4 +143,3 @@ References
141143- `ESP-IDF KConfig Language Reference <https://docs.espressif.com/projects/esp-idf-kconfig/en/latest/kconfiglib/language.html >`_
142144- `KConfig Language Documentation <https://www.kernel.org/doc/Documentation/kbuild/kconfig-language.txt >`_
143145- `Eclipse TM4E Documentation <https://github.com/eclipse/tm4e >`_
144-
0 commit comments