Re: Emacs documentation sources
  Home FAQ Contact Sign in
gnu.emacs.help only
 
Advanced search
POPULAR GROUPS

more...

gnu.emacs.help Profile…
 Up
Re: Emacs documentation sources         


Author: Eli Zaretskii
Date: Sep 26, 2007 02:23

> Date: Wed, 26 Sep 2007 09:04:57 +0100
> From: "Dave Pawson" gmail.com>
>
> http://www.emacswiki.org/cgi-bin/emacs-en/CategoryDocumentation

IMO, it should describe much more Info-mode commands. Without using
the manual, the Emacs help system is quite crippled, especially for
newbies. Doc strings not always target newbies, because they cannot
be too wordy (due to considerations of memory footprint of the running
Emacs).
11 Comments
Re: Emacs documentation sources         


Author: David Kastrup
Date: Sep 26, 2007 12:53

Eli Zaretskii gnu.org> writes:
>> Date: Wed, 26 Sep 2007 09:04:57 +0100
>> From: "Dave Pawson" gmail.com>
>>
>> http://www.emacswiki.org/cgi-bin/emacs-en/CategoryDocumentation
>
> IMO, it should describe much more Info-mode commands. Without using
> the manual, the Emacs help system is quite crippled, especially for
> newbies. Doc strings not always target newbies, because they cannot
> be too wordy (due to considerations of memory footprint of the running
> Emacs).

Uh what? Doc strings are not placed in the memory of Emacs except for
those of uncompiled Lisp code.

--
David Kastrup, Kriemhildstr. 15, 44793 Bochum
no comments
Re: Emacs documentation sources         


Author: Eli Zaretskii
Date: Sep 26, 2007 14:18

> From: David Kastrup gnu.org>
> Date: Wed, 26 Sep 2007 21:53:00 +0200
>
> Uh what? Doc strings are not placed in the memory of Emacs except for
> those of uncompiled Lisp code.

You mean, when I'm looking at a buffer that displays the doc string of
something, that doc string is not in memory?
no comments
Re: Emacs documentation sources         


Author: David Kastrup
Date: Sep 26, 2007 23:17

Eli Zaretskii gnu.org> writes:
>> From: David Kastrup gnu.org>
>> Date: Wed, 26 Sep 2007 21:53:00 +0200
>>
>> Uh what? Doc strings are not placed in the memory of Emacs except for
>> those of uncompiled Lisp code.
>
> You mean, when I'm looking at a buffer that displays the doc string of
> something, that doc string is not in memory?

Only as long as the help buffer persists with this content. Do you
really claim the ephemeral size of the help buffer to be an important
consideration concerning the size of DOC strings?

--
David Kastrup, Kriemhildstr. 15, 44793 Bochum
no comments
Re: Emacs documentation sources         


Author: Eli Zaretskii
Date: Sep 27, 2007 00:59

> From: David Kastrup gnu.org>
> Date: Thu, 27 Sep 2007 08:17:13 +0200
>
> Do you really claim the ephemeral size of the help buffer to be an
> important consideration concerning the size of DOC strings?

Do you really claim that the size of DOC strings is of no concern at
all?
no comments
Re: Emacs documentation sources         


Author: David Kastrup
Date: Sep 27, 2007 13:17

Eli Zaretskii gnu.org> writes:
>> From: David Kastrup gnu.org>
>> Date: Thu, 27 Sep 2007 08:17:13 +0200
>>
>> Do you really claim the ephemeral size of the help buffer to be an
>> important consideration concerning the size of DOC strings?
>
> Do you really claim that the size of DOC strings is of no concern at
> all?

Since they reside in the .elc files and/or the DOC file and are only
ever loaded into memory temporarily when they are actually consulted,
they take up only disk space, not main memory. Just like the manual.

So yes, I disagree with the following claim of you that you made in
the thread and seemingly already forgot:

Doc strings not always target newbies, because they cannot be too
wordy (due to considerations of memory footprint of the running
Emacs).
Show full article (1.01Kb)
no comments
Re: Emacs documentation sources         


Author: Eli Zaretskii
Date: Sep 28, 2007 01:13

> From: David Kastrup gnu.org>
> Date: Thu, 27 Sep 2007 22:17:40 +0200
>
>> Do you really claim that the size of DOC strings is of no concern at
>> all?
>
> Since they reside in the .elc files and/or the DOC file and are only
> ever loaded into memory temporarily when they are actually consulted,
> they take up only disk space, not main memory. Just like the manual.

Perhaps you should re-read th relevant sources before you make such
assertions. What I see there is that each displayed doc string is
kept in memory twice, and it remains in memory until the next GC.

So, temporary or not, the doc strings do in fact occupy memory for
more than a split second.
no comments
Re: Emacs documentation sources         


Author: Stefan Monnier
Date: Sep 28, 2007 08:31

>> Do you really claim the ephemeral size of the help buffer to be an
>> important consideration concerning the size of DOC strings?
> Do you really claim that the size of DOC strings is of no concern at
> all?

Yes.

Stefan
no comments
Re: Emacs documentation sources         


Author: Stefan Monnier
Date: Sep 28, 2007 08:36

>>> Do you really claim that the size of DOC strings is of no concern at
>>> all?
>>
>> Since they reside in the .elc files and/or the DOC file and are only
>> ever loaded into memory temporarily when they are actually consulted,
>> they take up only disk space, not main memory. Just like the manual.
> Perhaps you should re-read th relevant sources before you make such
> assertions. What I see there is that each displayed doc string is
> kept in memory twice, and it remains in memory until the next GC.
> So, temporary or not, the doc strings do in fact occupy memory for
> more than a split second.

Absolutely negligible. If you add 10KB to a docstring (i.e. a *lot* more
text), that will add in the order of 10-20KB to the Emacs process on the
conditions that the user has looked at that docstring. I.e. it will bump
the process's size from maybe 10MB to 10.02MB. If you add 10KB to each and
every docstring ever written, then the process size will grow by about 10KB
times the number of docstring viewed in *Help*.
Absolutely negligible.

Stefan
no comments
Re: Emacs documentation sources         


Author: David Kastrup
Date: Sep 28, 2007 16:13

Eli Zaretskii gnu.org> writes:
>> From: David Kastrup gnu.org>
>> Date: Thu, 27 Sep 2007 22:17:40 +0200
>>
>>> Do you really claim that the size of DOC strings is of no concern at
>>> all?
>>
>> Since they reside in the .elc files and/or the DOC file and are only
>> ever loaded into memory temporarily when they are actually consulted,
>> they take up only disk space, not main memory. Just like the manual.
>
> Perhaps you should re-read th relevant sources before you make such
> assertions. What I see there is that each displayed doc string is
> kept in memory twice, and it remains in memory until the next GC.
>
> So, temporary or not, the doc strings do in fact occupy memory for
> more than a split second.
Show full article (1.67Kb)
no comments
1 2