diff mbox series

[v1] docs: kbuild: Document search jump feature

Message ID 20230805034445.2508362-1-Mr.Bossman075@gmail.com (mailing list archive)
State Accepted
Headers show
Series [v1] docs: kbuild: Document search jump feature | expand

Commit Message

Jesse Taube Aug. 5, 2023, 3:44 a.m. UTC
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.

Signed-off-by: Jesse Taube <Mr.Bossman075@gmail.com>
---
 Documentation/kbuild/kconfig.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Randy Dunlap Aug. 5, 2023, 4:08 a.m. UTC | #1
On 8/4/23 20:44, Jesse Taube wrote:
> 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.
> 
> Signed-off-by: Jesse Taube <Mr.Bossman075@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.


More below...

> ---
>  Documentation/kbuild/kconfig.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/Documentation/kbuild/kconfig.rst b/Documentation/kbuild/kconfig.rst
> index 5967c79c3baa..463914a7fdec 100644
> --- a/Documentation/kbuild/kconfig.rst
> +++ b/Documentation/kbuild/kconfig.rst
> @@ -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?

>  ----------------------------------------------------------------------
>  
>  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.
Jesse Taube Aug. 5, 2023, 4:42 a.m. UTC | #2
On Sat, Aug 5, 2023 at 12:08 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
>
>
> On 8/4/23 20:44, Jesse Taube wrote:
> > 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.
> >
> > Signed-off-by: Jesse Taube <Mr.Bossman075@gmail.com>
>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Thanks.
>
>
> More below...
>
> > ---
> >  Documentation/kbuild/kconfig.rst | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> >
> > diff --git a/Documentation/kbuild/kconfig.rst b/Documentation/kbuild/kconfig.rst
> > index 5967c79c3baa..463914a7fdec 100644
> > --- a/Documentation/kbuild/kconfig.rst
> > +++ b/Documentation/kbuild/kconfig.rst
> > @@ -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.

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

> 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
>
> >  ----------------------------------------------------------------------
> >
> >  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.
>
> --
> ~Randy
Masahiro Yamada Aug. 6, 2023, 1:48 p.m. UTC | #3
On Sat, Aug 5, 2023 at 12:44 PM Jesse Taube <mr.bossman075@gmail.com> wrote:
>
> 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.
>
> Signed-off-by: Jesse Taube <Mr.Bossman075@gmail.com>
> ---
>  Documentation/kbuild/kconfig.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/Documentation/kbuild/kconfig.rst b/Documentation/kbuild/kconfig.rst
> index 5967c79c3baa..463914a7fdec 100644
> --- a/Documentation/kbuild/kconfig.rst
> +++ b/Documentation/kbuild/kconfig.rst
> @@ -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.
> --
> 2.40.0
>


Applied to linux-kbuild.
Thanks.
diff mbox series

Patch

diff --git a/Documentation/kbuild/kconfig.rst b/Documentation/kbuild/kconfig.rst
index 5967c79c3baa..463914a7fdec 100644
--- a/Documentation/kbuild/kconfig.rst
+++ b/Documentation/kbuild/kconfig.rst
@@ -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.