bug#11036: 24.0.94; imagemagick-render-type is void as a variable

bug#11036: 24.0.94; imagemagick-render-type is void as a variable

[Leo]

My emacs is built without imagemagick support and I am seeing this:

imagemagick-render-type is a variable defined in `C source code'.
It is void as a variable.

Documentation:
Integer indicating which ImageMagick rendering method to use.
The options are:
  0 -- the default method (pixel pushing)
  1 -- a newer method ("MagickExportImagePixels") that may perform
       better (speed etc) in some cases, but has not been as thoroughly
       tested with Emacs as the default method.  This method requires
       ImageMagick version 6.4.6 (approximately) or later.


Leo

bug#11036: 24.0.94; imagemagick-render-type is void as a variable

[Eli Zaretskii]

> From: Leo <sdl.web@gmail.com>
> Date: Sat, 17 Mar 2012 11:07:10 +0800
> 
> My emacs is built without imagemagick support and I am seeing this:
> 
> imagemagick-render-type is a variable defined in `C source code'.
> It is void as a variable.
> 
> Documentation:
> Integer indicating which ImageMagick rendering method to use.
> The options are:
>   0 -- the default method (pixel pushing)
>   1 -- a newer method ("MagickExportImagePixels") that may perform
>        better (speed etc) in some cases, but has not been as thoroughly
>        tested with Emacs as the default method.  This method requires
>        ImageMagick version 6.4.6 (approximately) or later.

Why do you consider this a problem?

bug#11036: 24.0.94; imagemagick-render-type is void as a variable

[Leo]

On 2012-03-17 16:52 +0800, Eli Zaretskii wrote:
> Why do you consider this a problem?

Do you see other void variables show up in C-h v?

Leo

bug#11036: 24.0.94; imagemagick-render-type is void as a variable

[Glenn Morris]

Leo wrote:

> On 2012-03-17 16:52 +0800, Eli Zaretskii wrote:
>> Why do you consider this a problem?
>
> Do you see other void variables show up in C-h v?

x-resource-name in a build without-x, for example.

bug#11036: 24.0.94; imagemagick-render-type is void as a variable

[Glenn Morris]

I guess it is because Snarf-documentation does not understand #ifdefs.
See also http://lists.gnu.org/archive/html/emacs-devel/2008-05/msg01545.html .
In this case, the symbol imagemagick-render-type appears in cus-start.el.

bug#11036: 24.0.94; imagemagick-render-type is void as a variable

[Glenn Morris]

Obviously not for 24.1, but the following seems to work.
Anything that is in DOC should be defined at startup if relevant to the
platform in use.

I compared the results of `C-h f TAB' and `C-h v TAB' with and without
this change, and it just removes a few more void things.
Eg for me, the variables: motif-version-string, gtk-version-string, 
ns-initialized.


*** src/doc.c	2012-02-06 16:53:51 +0000
--- src/doc.c	2012-03-20 20:50:48 +0000
***************
*** 671,676 ****
--- 671,677 ----
  		  /* Install file-position as variable-documentation property
  		     and make it negative for a user-variable
  		     (doc starts with a `*').  */
+                   if (!NILP (Fboundp (sym)))
                      Fput (sym, Qvariable_documentation,
                            make_number ((pos + end + 1 - buf)
                                         * (end[1] == '*' ? -1 : 1)));
***************
*** 678,685 ****
  
  	      /* Attach a docstring to a function?  */
  	      else if (p[1] == 'F')
  		store_function_docstring (sym, pos + end + 1 - buf);
! 
  	      else if (p[1] == 'S')
  		; /* Just a source file name boundary marker.  Ignore it.  */
  
--- 679,688 ----
  
  	      /* Attach a docstring to a function?  */
  	      else if (p[1] == 'F')
+                 {
+                   if (!NILP (Ffboundp (sym)))
                      store_function_docstring (sym, pos + end + 1 - buf);
!                 }
  	      else if (p[1] == 'S')
  		; /* Just a source file name boundary marker.  Ignore it.  */
  

bug#11036: 24.0.94; imagemagick-render-type is void as a variable

[Leo]

On 2012-03-21 05:06 +0800, Glenn Morris wrote:
> Obviously not for 24.1, but the following seems to work.
> Anything that is in DOC should be defined at startup if relevant to the
> platform in use.

Thank you for fixing this.

Leo

bug#11036: 24.0.94; imagemagick-render-type is void as a variable

[Glenn Morris]

Version: 24.2

Patch applied to trunk.