Minor addition to Speed Keys info node

Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 2029 bytes --]

Hello,

Here is a patch with some info added to make Speed Keys more accessible to
users (inspired by [1]).

From 43ff4c3da12a8ce0333c65372ab8ba51964e7a2a Mon Sep 17 00:00:00 2001
From: Kaushal Modi <kaushal.modi@gmail.com>
Date: Wed, 7 Jun 2017 11:34:39 -0400
Subject: [PATCH] Mention org-speed-command-help in Speed Keys info node

* doc/org.texi (Speed keys): Mention org-speed-command-help.
---
 doc/org.texi | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 11c4ac4c72..75bb9c79a2 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -17028,14 +17028,16 @@ navigation, Speed Keys may come in handy on small
mobile devices that do not
 have full keyboards.  Speed Keys may also work on TTY devices known for
their
 problems when entering Emacs keychords.

-By default, Org has Speed Keys disabled.  To activate Speed Keys, configure
-the variable @code{org-use-speed-commands}.  To trigger a Speed Key, the
-cursor must be at the beginning of an Org headline, before any of the
stars.
-
-Org comes with a pre-defined list of Speed Keys; @kbd{?} shows currently
-active Speed Keys.  To add or modify Speed Keys, customize the variable,
-@code{org-speed-commands-user}.  For more details, see the variable's
-docstring.
+By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
+variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
+Speed Key, the cursor must be at the beginning of an Org headline, before
any
+of the stars.
+
+Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
+Keys, customize the variable, @code{org-speed-commands-user}.  For more
+details, see the variable's docstring.  With Speed Keys activated, @kbd{M-x
+org-speed-command-help} or @kbd{?} (when cursor is at the beginning of an
Org
+headline) shows currently active Speed Keys, including the user-defined
ones.


 @node Code evaluation security
-- 
2.13.0

[1]: https://emacs.stackexchange.com/q/33310/115
-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 2766 bytes --]

Re: Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 257 bytes --]

The patch is rebased off the maint branch.

On Wed, Jun 7, 2017 at 11:39 AM Kaushal Modi <kaushal.modi@gmail.com> wrote:

> Hello,
>
> Here is a patch with some info added to make Speed Keys more accessible to
> users (inspired by [1]).
>
-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 671 bytes --]

Re: Minor addition to Speed Keys info node

[Nicolas Goaziou]

Hello,

Kaushal Modi <kaushal.modi@gmail.com> writes:

> +Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
> +Keys, customize the variable, @code{org-speed-commands-user}.  For more
> +details, see the variable's docstring.  With Speed Keys activated, @kbd{M-x
> +org-speed-command-help} or @kbd{?} (when cursor is at the beginning of an

@kbd{?}---when cursor is at the beginning of an Org headline---shows
currently active Speed Keys,...

> Org +headline) shows currently active Speed Keys, including the
> user-defined ones.

Otherwise, LGTM.

Thank you.

Regards,

-- 
Nicolas Goaziou

Re: Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 2248 bytes --]

On Wed, Jun 7, 2017 at 12:21 PM Nicolas Goaziou <mail@nicolasgoaziou.fr>
wrote:

> @kbd{?}---when cursor is at the beginning of an Org headline---shows
> currently active Speed Keys,...
>
> > Org +headline) shows currently active Speed Keys, including the
> > user-defined ones.
>
> Otherwise, LGTM.
>

Thanks. I was unaware of the --- syntax.

Here's the updated patch:

From 1a767fb97b680b9fef5d0fd301c9fcf951b705e3 Mon Sep 17 00:00:00 2001
From: Kaushal Modi <kaushal.modi@gmail.com>
Date: Wed, 7 Jun 2017 11:34:39 -0400
Subject: [PATCH] Mention org-speed-command-help in Speed Keys info node

* doc/org.texi (Speed keys): Mention org-speed-command-help.
---
 doc/org.texi | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 11c4ac4c72..50a96333f2 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -17028,14 +17028,17 @@ navigation, Speed Keys may come in handy on small
mobile devices that do not
 have full keyboards.  Speed Keys may also work on TTY devices known for
their
 problems when entering Emacs keychords.

-By default, Org has Speed Keys disabled.  To activate Speed Keys, configure
-the variable @code{org-use-speed-commands}.  To trigger a Speed Key, the
-cursor must be at the beginning of an Org headline, before any of the
stars.
-
-Org comes with a pre-defined list of Speed Keys; @kbd{?} shows currently
-active Speed Keys.  To add or modify Speed Keys, customize the variable,
-@code{org-speed-commands-user}.  For more details, see the variable's
-docstring.
+By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
+variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
+Speed Key, the cursor must be at the beginning of an Org headline, before
any
+of the stars.
+
+Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
+Keys, customize the variable, @code{org-speed-commands-user}.  For more
+details, see the variable's docstring.  With Speed Keys activated, @kbd{M-x
+org-speed-command-help} or @kbd{?}---when cursor is at the beginning of an
+Org headline---shows currently active Speed Keys, including the
user-defined
+ones.


 @node Code evaluation security
-- 
2.13.0


-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 3200 bytes --]

Re: Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 4531 bytes --]

One minor iteration.. I think below reads with a better flow.. WDYT?

@kbd{M-x org-speed-command-help}, or @kbd{?} when cursor is at the
beginning of an Org headline, shows currently ..

Here's the full patch:

From 5886b6f7fe82858ae49b55d409d1baf20942dae8 Mon Sep 17 00:00:00 2001
From: Kaushal Modi <kaushal.modi@gmail.com>
Date: Wed, 7 Jun 2017 11:34:39 -0400
Subject: [PATCH] Mention org-speed-command-help in Speed Keys info node

* doc/org.texi (Speed keys): Mention org-speed-command-help.
---
 doc/org.texi | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 11c4ac4c72..04485b12e0 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -17028,14 +17028,16 @@ navigation, Speed Keys may come in handy on small
mobile devices that do not
 have full keyboards.  Speed Keys may also work on TTY devices known for
their
 problems when entering Emacs keychords.

-By default, Org has Speed Keys disabled.  To activate Speed Keys, configure
-the variable @code{org-use-speed-commands}.  To trigger a Speed Key, the
-cursor must be at the beginning of an Org headline, before any of the
stars.
-
-Org comes with a pre-defined list of Speed Keys; @kbd{?} shows currently
-active Speed Keys.  To add or modify Speed Keys, customize the variable,
-@code{org-speed-commands-user}.  For more details, see the variable's
-docstring.
+By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
+variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
+Speed Key, the cursor must be at the beginning of an Org headline, before
any
+of the stars.
+
+Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
+Keys, customize the variable, @code{org-speed-commands-user}.  For more
+details, see the variable's docstring.  With Speed Keys activated, @kbd{M-x
+org-speed-command-help}, or @kbd{?} when cursor is at the beginning of an
Org
+headline, shows currently active Speed Keys, including the user-defined
ones.


 @node Code evaluation security
-- 
2.13.0




On Wed, Jun 7, 2017 at 12:32 PM Kaushal Modi <kaushal.modi@gmail.com> wrote:

> On Wed, Jun 7, 2017 at 12:21 PM Nicolas Goaziou <mail@nicolasgoaziou.fr>
> wrote:
>
>> @kbd{?}---when cursor is at the beginning of an Org headline---shows
>> currently active Speed Keys,...
>>
>> > Org +headline) shows currently active Speed Keys, including the
>> > user-defined ones.
>>
>> Otherwise, LGTM.
>>
>
> Thanks. I was unaware of the --- syntax.
>
> Here's the updated patch:
>
> From 1a767fb97b680b9fef5d0fd301c9fcf951b705e3 Mon Sep 17 00:00:00 2001
> From: Kaushal Modi <kaushal.modi@gmail.com>
> Date: Wed, 7 Jun 2017 11:34:39 -0400
> Subject: [PATCH] Mention org-speed-command-help in Speed Keys info node
>
> * doc/org.texi (Speed keys): Mention org-speed-command-help.
> ---
>  doc/org.texi | 19 +++++++++++--------
>  1 file changed, 11 insertions(+), 8 deletions(-)
>
> diff --git a/doc/org.texi b/doc/org.texi
> index 11c4ac4c72..50a96333f2 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -17028,14 +17028,17 @@ navigation, Speed Keys may come in handy on
> small mobile devices that do not
>  have full keyboards.  Speed Keys may also work on TTY devices known for
> their
>  problems when entering Emacs keychords.
>
> -By default, Org has Speed Keys disabled.  To activate Speed Keys,
> configure
> -the variable @code{org-use-speed-commands}.  To trigger a Speed Key, the
> -cursor must be at the beginning of an Org headline, before any of the
> stars.
> -
> -Org comes with a pre-defined list of Speed Keys; @kbd{?} shows currently
> -active Speed Keys.  To add or modify Speed Keys, customize the variable,
> -@code{org-speed-commands-user}.  For more details, see the variable's
> -docstring.
> +By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
> +variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
> +Speed Key, the cursor must be at the beginning of an Org headline, before
> any
> +of the stars.
> +
> +Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
> +Keys, customize the variable, @code{org-speed-commands-user}.  For more
> +details, see the variable's docstring.  With Speed Keys activated,
> @kbd{M-x
> +org-speed-command-help} or @kbd{?}---when cursor is at the beginning of an
> +Org headline---shows currently active Speed Keys, including the
> user-defined
> +ones.
>
>
>  @node Code evaluation security
> --
> 2.13.0
>
>
> --
>
> Kaushal Modi
>
-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 6662 bytes --]

Re: Minor addition to Speed Keys info node

[Nicolas Goaziou]

Kaushal Modi <kaushal.modi@gmail.com> writes:

> One minor iteration.. I think below reads with a better flow.. WDYT?

[...]

@vindex org-use-speed-commands
> +By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
> +variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
> +Speed Key, the cursor must be at the beginning of an Org headline, before
> any
> +of the stars.

@vindex org-speed-commands-user
> +Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
> +Keys, customize the variable, @code{org-speed-commands-user}.  For more
> +details, see the variable's docstring.  With Speed Keys activated, @kbd{M-x
> +org-speed-command-help}, or @kbd{?} when cursor is at the beginning of an
> Org
> +headline, shows currently active Speed Keys, including the user-defined
> ones.

Barring the two additions above, it looks good. Thank you.

Regards,

Re: Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1.1: Type: text/plain, Size: 1252 bytes --]

On Wed, Jun 7, 2017 at 4:21 PM Nicolas Goaziou <mail@nicolasgoaziou.fr>
wrote:

> @vindex org-use-speed-commands
> > +By default, Org has Speed Keys disabled.  To activate Speed Keys, set
> the
> > +variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
> > +Speed Key, the cursor must be at the beginning of an Org headline,
> before
> > any
> > +of the stars.
>
> @vindex org-speed-commands-user
> > +Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
> > +Keys, customize the variable, @code{org-speed-commands-user}.  For more
> > +details, see the variable's docstring.  With Speed Keys activated,
> @kbd{M-x
> > +org-speed-command-help}, or @kbd{?} when cursor is at the beginning of
> an
> > Org
> > +headline, shows currently active Speed Keys, including the user-defined
> > ones.
>
> Barring the two additions above, it looks good. Thank you.
>

I see that the vindex tags are already there:
http://orgmode.org/cgit.cgi/org-mode.git/tree/doc/org.texi?id=8305c9381efaf3ad5f95ee96bb15209f3d687707#n17021


[image: image.png]
Or I didn't understand where I need to add those.. Did you mean that I need
to move those tags closer to where those vars are actually referenced in
that node?

-- 

Kaushal Modi

[-- Attachment #1.2: Type: text/html, Size: 1950 bytes --]

[-- Attachment #2: image.png --]
[-- Type: image/png, Size: 16659 bytes --]

Re: Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1.1: Type: text/plain, Size: 2740 bytes --]

On Wed, Jun 7, 2017 at 4:44 PM Kaushal Modi <kaushal.modi@gmail.com> wrote:

> Did you mean that I need to move those tags closer to where those vars are
> actually referenced in that node?
>

Seems like that was the intention. Also as I am referring to the
org-speed-command-help function for the first time in the manual at the
appropriate place, I have added an findex for that too.

Revised patch for maint:

From d15b72a0c8983eb2007c2393c3d76ba74eada109 Mon Sep 17 00:00:00 2001
From: Kaushal Modi <kaushal.modi@gmail.com>
Date: Wed, 7 Jun 2017 11:34:39 -0400
Subject: [PATCH] Mention org-speed-command-help in Speed Keys info node

* doc/org.texi (Speed keys): Mention org-speed-command-help.
---
 doc/org.texi | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 11c4ac4c72..2ac142fc2b 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -17018,8 +17018,6 @@ More templates can added by customizing the variable
 @node Speed keys
 @section Speed keys
 @cindex speed keys
-@vindex org-use-speed-commands
-@vindex org-speed-commands-user

 Single keystrokes can execute custom commands in an Org file when the
cursor
 is on a headline.  Without the extra burden of a meta or modifier key,
Speed
@@ -17028,14 +17026,19 @@ navigation, Speed Keys may come in handy on small
mobile devices that do not
 have full keyboards.  Speed Keys may also work on TTY devices known for
their
 problems when entering Emacs keychords.

-By default, Org has Speed Keys disabled.  To activate Speed Keys, configure
-the variable @code{org-use-speed-commands}.  To trigger a Speed Key, the
-cursor must be at the beginning of an Org headline, before any of the
stars.
+@vindex org-use-speed-commands
+By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
+variable @code{org-use-speed-commands} to a non-nil value.  To trigger a
+Speed Key, the cursor must be at the beginning of an Org headline, before
any
+of the stars.

-Org comes with a pre-defined list of Speed Keys; @kbd{?} shows currently
-active Speed Keys.  To add or modify Speed Keys, customize the variable,
-@code{org-speed-commands-user}.  For more details, see the variable's
-docstring.
+@vindex org-speed-commands-user
+@findex org-speed-command-help
+Org comes with a pre-defined list of Speed Keys.  To add or modify Speed
+Keys, customize the variable, @code{org-speed-commands-user}.  For more
+details, see the variable's docstring.  With Speed Keys activated, @kbd{M-x
+org-speed-command-help}, or @kbd{?} when cursor is at the beginning of an
Org
+headline, shows currently active Speed Keys, including the user-defined
ones.


 @node Code evaluation security
-- 
2.13.0


-- 

Kaushal Modi

[-- Attachment #1.2: Type: text/html, Size: 3839 bytes --]

[-- Attachment #2: image.png --]
[-- Type: image/png, Size: 16659 bytes --]

Re: Minor addition to Speed Keys info node

[Nicolas Goaziou]

Kaushal Modi <kaushal.modi@gmail.com> writes:

> On Wed, Jun 7, 2017 at 4:44 PM Kaushal Modi <kaushal.modi@gmail.com> wrote:
>
>> Did you mean that I need to move those tags closer to where those vars are
>> actually referenced in that node?
>>
>
> Seems like that was the intention.

Correct.

>Also as I am referring to the org-speed-command-help function for the
>first time in the manual at the appropriate place, I have added an
>findex for that too.

OK.

> +By default, Org has Speed Keys disabled.  To activate Speed Keys, set the
> +variable @code{org-use-speed-commands} to a non-nil value.

I overlooked this one: non-@code{nil}

I think you can push this, or we are going to nitpick over it until the
end of time ;)

Regards,

Re: Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 657 bytes --]

On Wed, Jun 7, 2017 at 5:34 PM Nicolas Goaziou <mail@nicolasgoaziou.fr>
wrote:

> > +By default, Org has Speed Keys disabled.  To activate Speed Keys, set
> the
> > +variable @code{org-use-speed-commands} to a non-nil value.
>
> I overlooked this one: non-@code{nil}
>

Fixed :)


>
> I think you can push this, or we are going to nitpick over it until the
> end of time ;)
>

Thanks! I just pushed to the maint branch for the very first time (using
magit on Termux on Nexus 6p!); also merged that to master. (That also
merged your last commit on maint into master. Hope that is fine.)

For future, should I refrain from doing the merges?
-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 1207 bytes --]

Re: Minor addition to Speed Keys info node

[Nicolas Goaziou]

Kaushal Modi <kaushal.modi@gmail.com> writes:

> Thanks! I just pushed to the maint branch for the very first time (using
> magit on Termux on Nexus 6p!); also merged that to master. (That also
> merged your last commit on maint into master. Hope that is fine.)

Congratulations, and thank you.

> For future, should I refrain from doing the merges?

Why would you? It is a good habit to merge maint into master after
a patch. I didn't do it for my own commit because I'm about to commit
something else and wanted to reduce a bit the number of merge commits.

Regards,

Re: Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 711 bytes --]

On Wed, Jun 7, 2017, 6:56 PM Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:

> Why would you? It is a good habit to merge maint into master after
> a patch.


Just because I cannot always be sure that all the commits made by someone
else in maint branch are applicable in master branch too.

I didn't do it for my own commit because I'm about to commit
> something else and wanted to reduce a bit the number of merge commits.


Thanks, that makes sense.

So typically one wouldn't come across a decision point if they should or
shouldn't merge the maint branch commits made by someone else.

And in the case there are commits that should not be merged to master, you
just cherry-pick, right?
-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 1325 bytes --]

Re: Minor addition to Speed Keys info node

[Nicolas Goaziou]

Hello,

Kaushal Modi <kaushal.modi@gmail.com> writes:

> And in the case there are commits that should not be merged to master, you
> just cherry-pick, right?

This never happens. Master is a strict superset of maint.

Regards,

-- 
Nicolas Goaziou

Re: Minor addition to Speed Keys info node

[Kaushal Modi]

[-- Attachment #1: Type: text/plain, Size: 209 bytes --]

On Thu, Jun 8, 2017 at 6:50 AM Nicolas Goaziou <mail@nicolasgoaziou.fr>
wrote:

> This never happens. Master is a strict superset of maint.
>

Thanks. That takes care of my merging concerns.
-- 

Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 561 bytes --]