Pattch to org.texi: Document ":eval no"

Pattch to org.texi: Document ":eval no"

[Stephen Eglen]

Small patch attached, thanks Seb for pointing this out.

Stephen

diff --git a/doc/org.texi b/doc/org.texi
index 3ecf897..eb45885 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -12990,10 +12990,10 @@ permissions of the tangled file are set to make it executable.
 @subsubsection @code{:eval}
 The @code{:eval} header argument can be used to limit the evaluation of
 specific code blocks.  @code{:eval} accepts two arguments ``never'' and
-``query''.  @code{:eval never} will ensure that a code block is never
-evaluated, this can be useful for protecting against the evaluation of
-dangerous code blocks.  @code{:eval query} will require a query for every
-execution of a code block regardless of the value of the
+``query''.  @code{:eval never} (or @code{:eval no}) will ensure that a code
+block is never evaluated, this can be useful for protecting against the
+evaluation of dangerous code blocks.  @code{:eval query} will require a query
+for every execution of a code block regardless of the value of the
 @code{org-confirm-babel-evaluate} variable.
 
 If this header argument is not set then evaluation is determined by the value

Re: Pattch to org.texi: Document ":eval no"

[Sebastien Vauban]

Hi Stephen,

Stephen Eglen wrote:
> Small patch attached, thanks Seb for pointing this out.
>
> Stephen
>
> diff --git a/doc/org.texi b/doc/org.texi
> index 3ecf897..eb45885 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -12990,10 +12990,10 @@ permissions of the tangled file are set to make it executable.
>  @subsubsection @code{:eval}
>  The @code{:eval} header argument can be used to limit the evaluation of
>  specific code blocks.  @code{:eval} accepts two arguments ``never'' and
> -``query''.  @code{:eval never} will ensure that a code block is never
> -evaluated, this can be useful for protecting against the evaluation of
> -dangerous code blocks.  @code{:eval query} will require a query for every
> -execution of a code block regardless of the value of the
> +``query''.  @code{:eval never} (or @code{:eval no}) will ensure that a code
> +block is never evaluated, this can be useful for protecting against the
> +evaluation of dangerous code blocks.  @code{:eval query} will require a query
> +for every execution of a code block regardless of the value of the
>  @code{org-confirm-babel-evaluate} variable.
>  
>  If this header argument is not set then evaluation is determined by the value

While this -- really! -- is an excellent initiative (to update the doc when
you notice something's missing).

Note that, would have better read my notes, instead of counting on my memory,
I would have told you ":eval never". Though, I just checked, and confirm that
":eval no" is (for the moment) equivalent to it: see ob.el, lines 218 and 226.

So, this patch makes sense -- except if Eric wants to let this option
disappear, and only supports it in the code for backward compatibility.

Best regards,
  Seb

-- 
Sebastien Vauban

Re: Pattch to org.texi: Document ":eval no"

[Eric Schulte]

Applied, Thanks for the patch -- Eric

"Sebastien Vauban" <wxhgmqzgwmuf@spammotel.com> writes:

> Hi Stephen,
>
> Stephen Eglen wrote:
>> Small patch attached, thanks Seb for pointing this out.
>>
>> Stephen
>>
>> diff --git a/doc/org.texi b/doc/org.texi
>> index 3ecf897..eb45885 100644
>> --- a/doc/org.texi
>> +++ b/doc/org.texi
>> @@ -12990,10 +12990,10 @@ permissions of the tangled file are set to make it executable.
>>  @subsubsection @code{:eval}
>>  The @code{:eval} header argument can be used to limit the evaluation of
>>  specific code blocks.  @code{:eval} accepts two arguments ``never'' and
>> -``query''.  @code{:eval never} will ensure that a code block is never
>> -evaluated, this can be useful for protecting against the evaluation of
>> -dangerous code blocks.  @code{:eval query} will require a query for every
>> -execution of a code block regardless of the value of the
>> +``query''.  @code{:eval never} (or @code{:eval no}) will ensure that a code
>> +block is never evaluated, this can be useful for protecting against the
>> +evaluation of dangerous code blocks.  @code{:eval query} will require a query
>> +for every execution of a code block regardless of the value of the
>>  @code{org-confirm-babel-evaluate} variable.
>>  
>>  If this header argument is not set then evaluation is determined by the value
>
> While this -- really! -- is an excellent initiative (to update the doc when
> you notice something's missing).
>
> Note that, would have better read my notes, instead of counting on my memory,
> I would have told you ":eval never". Though, I just checked, and confirm that
> ":eval no" is (for the moment) equivalent to it: see ob.el, lines 218 and 226.
>
> So, this patch makes sense -- except if Eric wants to let this option
> disappear, and only supports it in the code for backward compatibility.
>
> Best regards,
>   Seb

-- 
Eric Schulte
http://cs.unm.edu/~eschulte/

Re: Pattch to org.texi: Document ":eval no"

[Bastien]

Hi Stephen,

Stephen Eglen <S.J.Eglen@damtp.cam.ac.uk> writes:

> Small patch attached, thanks Seb for pointing this out.

Thanks for the patch -- I'm willing to apply it, but I'd rather apply a
complete patch, i.e. one with a ChangeLog entry.  Can you update it?

Put the cursor on your change in org.texi and use `C-x 4 a' to create a
proper ChangeLog entry, then copy this entry to the commit message.

Thanks in advance!

-- 
 Bastien

Re: Pattch to org.texi: Document ":eval no"

[Stephen Eglen]

> > Small patch attached, thanks Seb for pointing this out.
> 
> Thanks for the patch -- I'm willing to apply it, but I'd rather apply a
> complete patch, i.e. one with a ChangeLog entry.  Can you update it?
> 
> Put the cursor on your change in org.texi and use `C-x 4 a' to create a
> proper ChangeLog entry, then copy this entry to the commit message.
> 
> Thanks in advance!

hi Bastien, thanks I'll remember that for future reference; for this
patch, it looks like Eric already applied it.  Stephen


commit c88c76b5519a27b3747344668d387f8561bf5fda
Author: Eric Schulte <schulte.eric@gmail.com>
Date:   Thu Jul 28 17:00:13 2011 -0600

    doc: flesh out description of ":eval" header argument
    
      Thanks to Stephen Eglen for this patch