Re: Double hyphens in variable names.

[Lute Kamstra]

David Ponce <address@hidden> writes:

>> When writing a major mode, you should never set imenu--index-alist
>> directly; nor should you have to use its value.  So it is not part
>> of Imenu's interface and therefore it is an internal variable.
>
> Perhaps there is a case it is necessary to use `imenu--index-alist':
> to force a rescan of the imenu.
>
> For example, the Semantic toolkit set `imenu--index-alist' to nil to
> force a rebuild of the imenu when the user customized an option that
> change how the imenu will be organized (item sorted and/or grouped
> in a different way).
>
> Is there another "standard" method to force a rescan of the imenu
> without using `imenu--index-alist'?

No, not on the lisp level.  There is a user-level way to do this: by
selecting the *Rescan* item from Imenu's menu.  Setting
imenu--index-alist to nil might work but it's not documented.  As it
seems useful for lisp programs to be able to force a rescan, we could
implement such a feature.  I'll try and see if I can come up with a
function that does this.

  Lute.