Skip to contentSkip to conversation

docs: kbuild: Document search jump feature

PATCH In review Jesse Taube 3 participants 4 messages Aug 5, 2023 – Aug 6, 2023

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: kbuild: Document search jump feature

Menuconfig has a feature where you can "press the key in the (#) prefix to jump directly to that location. You will be returned to the current search results after exiting this new menu."

This feature is poorly documented,
so add it to the kconfig.rst documentation.

---
 Documentation/kbuild/kconfig.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/kbuild/kconfig.rst +8 -0
index 5967c79c3baa..463914a7fdec 100644
@@ -210,6 +210,10 @@ Searching in menuconfig:
 	first (and in alphabetical order), then come all other symbols,
 	sorted in alphabetical order.
 
+	In this menu, pressing the key in the (#) prefix will jump
+	directly to that location. You will be returned to the current
+	search results after exiting this new menu.
+
 ----------------------------------------------------------------------
 
 User interface options for 'menuconfig'
@@ -262,6 +266,10 @@ Searching in nconfig:
 	F8 (SymSearch) searches the configuration symbols for the
 	given string or regular expression (regex).
 
+	In the SymSearch, pressing the key in the (#) prefix will
+	jump directly to that location. You will be returned to the
+	current search results after exiting this new menu.
+
 NCONFIG_MODE
 ------------
 This mode shows all sub-menus in one large tree.
Signature · 1 line
2.40.0
reviewer Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · Jesse Taube

Menuconfig has a feature where you can "press the key in the (#) prefix to jump directly to that location. You will be returned to the current search results after exiting this new menu."

This feature is poorly documented,
so add it to the kconfig.rst documentation.

Thanks.

More below...

Quoted 9 lines
---
 Documentation/kbuild/kconfig.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/kbuild/kconfig.rst +0 -0
index 5967c79c3baa..463914a7fdec 100644

Documentation/kbuild/kconfig.rst Searching in menuconfig: · line 216

Quoted 7 lines
Documentation/kbuild/kconfig.rst +4 -0
@@ -210,6 +210,10 @@ Searching in menuconfig:
 	first (and in alphabetical order), then come all other symbols,
 	sorted in alphabetical order.
 
+	In this menu, pressing the key in the (#) prefix will jump
+	directly to that location. You will be returned to the current
+	search results after exiting this new menu.
+

In menuconfig, exiting returns to the correct location in the search output, but in nconfig, exiting always returns to the top of the search output, not to where the (#) was displayed on the search output screen.
This is annoying.
Is this something that you have possibly already fixed?

Quoted 14 lines
Documentation/kbuild/kconfig.rst +4 -0
 ----------------------------------------------------------------------
 
 User interface options for 'menuconfig'
@@ -262,6 +266,10 @@ Searching in nconfig:
 	F8 (SymSearch) searches the configuration symbols for the
 	given string or regular expression (regex).
 
+	In the SymSearch, pressing the key in the (#) prefix will
+	jump directly to that location. You will be returned to the
+	current search results after exiting this new menu.
+
 NCONFIG_MODE
 ------------
 This mode shows all sub-menus in one large tree.
Signature · 1 line
~Randy
author
#2 lore raw
Quoted 31 lines · Randy Dunlap
Quoted 8 lines · Jesse Taube

Menuconfig has a feature where you can "press the key in the (#) prefix to jump directly to that location. You will be returned to the current search results after exiting this new menu."

This feature is poorly documented,
so add it to the kconfig.rst documentation.

Thanks.

More below...

Quoted 12 lines
---
 Documentation/kbuild/kconfig.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/kbuild/kconfig.rst +0 -0
index 5967c79c3baa..463914a7fdec 100644
@@ -210,6 +210,10 @@ Searching in menuconfig:
      first (and in alphabetical order), then come all other symbols,
      sorted in alphabetical order.
 
Quoted 8 lines

Documentation/kbuild/kconfig.rst Searching in menuconfig: · line 216

Quoted 4 lines
Documentation/kbuild/kconfig.rst +4 -0
+     In this menu, pressing the key in the (#) prefix will jump
+     directly to that location. You will be returned to the current
+     search results after exiting this new menu.
+

In menuconfig, exiting returns to the correct location in the search output, but in nconfig, exiting always returns to the top of the search output, not to where the (#) was displayed on the search output screen.

I honestly didn't notice this, in nconfig thank you for pointing it out.

Quoted 2 lines

This is annoying.
Is this something that you have possibly already fixed?

No, but I will look into it, hopefully, it's a trivial fix. I will submit a patch soon to fix this.

Thanks,
Jesse Taube

Quoted 18 lines
Quoted 5 lines
Documentation/kbuild/kconfig.rst +0 -0
 ----------------------------------------------------------------------
 
 User interface options for 'menuconfig'

Documentation/kbuild/kconfig.rst Searching in nconfig: · line 275

Quoted 10 lines
Documentation/kbuild/kconfig.rst +4 -0
@@ -262,6 +266,10 @@ Searching in nconfig:
      F8 (SymSearch) searches the configuration symbols for the
      given string or regular expression (regex).
 
+     In the SymSearch, pressing the key in the (#) prefix will
+     jump directly to that location. You will be returned to the
+     current search results after exiting this new menu.
+
 NCONFIG_MODE
 ------------
 This mode shows all sub-menus in one large tree.

--
~Randy

#3 lore raw
In reply to Jesse Taube
Quoted 40 lines · Jesse Taube

Menuconfig has a feature where you can "press the key in the (#) prefix to jump directly to that location. You will be returned to the current search results after exiting this new menu."

This feature is poorly documented,
so add it to the kconfig.rst documentation.

---
 Documentation/kbuild/kconfig.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/kbuild/kconfig.rst +8 -1
index 5967c79c3baa..463914a7fdec 100644
@@ -210,6 +210,10 @@ Searching in menuconfig:
        first (and in alphabetical order), then come all other symbols,
        sorted in alphabetical order.
 
+       In this menu, pressing the key in the (#) prefix will jump
+       directly to that location. You will be returned to the current
+       search results after exiting this new menu.
+
 ----------------------------------------------------------------------
 
 User interface options for 'menuconfig'
@@ -262,6 +266,10 @@ Searching in nconfig:
        F8 (SymSearch) searches the configuration symbols for the
        given string or regular expression (regex).
 
+       In the SymSearch, pressing the key in the (#) prefix will
+       jump directly to that location. You will be returned to the
+       current search results after exiting this new menu.
+
 NCONFIG_MODE
 ------------
 This mode shows all sub-menus in one large tree.
--
Quoted 2 lines

2.40.0

Applied to linux-kbuild.
Thanks.

Signature · 2 lines
Best Regards
Masahiro Yamada