From: Alex Schroeder <alex@emacswiki.org>
Cc: <emacs-devel@gnu.org>
Subject: Re: Documentation Question
Date: Mon, 02 Dec 2002 23:29:26 +0100 [thread overview]
Message-ID: <87lm38hx6h.fsf@emacswiki.org> (raw)
In-Reply-To: <00e301c29a2a$59f53020$444f6181@swag07> ("Andrew Trevors"'s message of "Mon, 2 Dec 2002 12:43:40 -0500")
"Andrew Trevors" <adtrevors@plg2.math.uwaterloo.ca> writes:
> Now, why I've posted this here is that I haven't had much luck finding
> any design type documentation that could be used to formulate a
> conceptual architecture. Is there any sort of docs or anything that
> is used to teach new programmers to the project, or is this type of
> thing usually up to the programmer himself by reading through
> code/comments.
For people joining the project, the source is the documentation,
specially for such tricky things as the redisplay engine.
Emacs basically implements a lisp interpreter in C, some editing
primitives in C, and the rest in lisp. So you need to decide now
wether to focus on Emacs-as-Lisp-engine or
Emacs-as-developing-environment.
For C authors, the source is the documentation. For Elisp authors,
Emacs provides an integrated help facility, and manuals. Some of
these document technical things such as the command loop, but very
often Elisp authors do not need this kind of in-depth information.
A paper by RMS describing one of the earliest Emacs implementations,
and some of the design concepts still used:
http://www.gnu.org/software/emacs/emacs-paper.html
Alex.
next prev parent reply other threads:[~2002-12-02 22:29 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2002-12-02 17:43 Documentation Question Andrew Trevors
2002-12-02 22:29 ` Alex Schroeder [this message]
2002-12-03 9:07 ` Thien-Thi Nguyen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87lm38hx6h.fsf@emacswiki.org \
--to=alex@emacswiki.org \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).