Re: [PATCH] elisp manual patch: add to file notification documentation

[Yoni Rabkin]

Stefan Kangas <stefankangas@gmail.com> writes:

> Yoni Rabkin <yoni@rabkins.net> writes:
>
>> The following elisp manual documentation patch explains to the user how
>> to check if their emacs was compiled with file notification support.
>
> If this is supposed to be user-facing, shouldn't it be renamed to
> `file-notify-library'?

Is the content of the elisp manual supposed to be user-facing? I guess
it depends on how you all define that term.

When I wrote "user" above, I was referring to the "user" of the elisp
manual, who is a person writing elisp.


>> diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
>> index 3e16ac0..2546074 100644
>> --- a/doc/lispref/os.texi
>> +++ b/doc/lispref/os.texi
>> @@ -3146,6 +3146,10 @@ respective library like @file{inotify}, @file{kqueue},
>>  @file{gfilenotify}, or @file{w32notify} statically.  These libraries
>>  enable watching of filesystems on the local machine.
>>
>> +The variable @var{file-notify--library} is non-nil when Emacs has been
>> +compiled with file notification support, and value is the name of the
>> +low-level file notification package to be used for local file systems.
>> +
>>  It is also possible to watch filesystems on remote machines,
>>  @pxref{Remote Files,, Remote Files, emacs, The GNU Emacs Manual}.
>>  This does not depend on one of the libraries linked to Emacs.
>

-- 
   "Cut your own wood and it will warm you twice"