@copying
This file describes EDE, the Emacs Development Environment.
-Copyright @copyright{} 1998, 1999, 2000, 2001, 2004, 2005, 2008, 2009, 2010
-Free Software Foundation, Inc.
+Copyright @copyright{} 1998-2001, 2004-2005, 2008-2011 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@end quotation
@end copying
-@ifinfo
-@format
-START-INFO-DIR-ENTRY
-* ede: (ede). Project management for Emacs
-END-INFO-DIR-ENTRY
-@end format
-@end ifinfo
+@dircategory Emacs misc features
+@direntry
+* EDE: (ede). The Emacs Development Environment.
+@end direntry
@titlepage
@center @titlefont{EDE (The Emacs Development Environment)}
@node EDE Mode, Creating a project, EDE Project Concepts, top
@chapter @ede{} Mode
-@ede{} is implemented as a minor-mode, which augments other modes such
+@ede{} is implemented as a minor mode, which augments other modes such
as C mode, and Texinfo mode. You can enable @ede{} for all buffers by
running the command @code{global-ede-mode}, or by putting this in your
-@file{~/.emacs} file:
+init file:
@example
(global-ede-mode t)
@end example
-When @ede{} is active for a given buffer, the menu item
-``Development'' appears. This menu provides several menu items for
-high-level @ede{} commands. These menu items, and their corresponding
-keybindings, are independent of the type of project you are actually
-working on.
+Activating @ede{} adds a menu named @samp{Development} to the menu
+bar. This menu provides several menu items for high-level @ede{}
+commands. These menu items, and their corresponding keybindings, are
+independent of the type of project you are actually working on.
@node Creating a project, Modifying your project, EDE Mode, top
@chapter Creating a project
To create a new project, first visit a file that you want to include
-in that project. If you have a hierarchy of directories, choose a
-file in the topmost directory first. From this buffer, type @kbd{M-x
+in that project. If you have a hierarchy of directories, first visit
+a file in the topmost directory. From this buffer, type @kbd{M-x
ede-new}, or click on the @samp{Create Project} item in the
@samp{Development} menu.
@node Add/Remove target, Add/Remove files, Modifying your project, Modifying your project
@section Add/Remove target
-To create a new target, type @kbd{C-c . t} (@code{M-x ede-new-target})
-or use the @samp{Add Target} menu item in the @samp{Project Options}
+To create a new target, type @kbd{C-c . t} (@code{ede-new-target}) or
+use the @samp{Add Target} menu item in the @samp{Project Options}
submenu. This prompts for a target name, and adds the current buffer
to that target.
@section Add/Remove files
To add the current file to an existing target, type @kbd{C-c . a}
-(@code{ede-add-file}), or or use the @samp{Add File} menu item in the
+(@code{ede-add-file}), or use the @samp{Add File} menu item in the
@samp{Target Options} submenu.
You can add a file to more than one target; this is OK.
To remove the current file from a target, type @kbd{C-c . d}
-(@code{ede-remove-file}), or or use the @samp{Remove File} menu item
+(@code{ede-remove-file}), or use the @samp{Remove File} menu item
in the @samp{Target Options} submenu. If the file belongs to multiple
targets, this command prompts for each target it could be removed
from.
Some project modes do not have a project file, but directly read a
Makefile or other existing file. Instead of directly editing the
-object, you can edit the file by typine @kbd{C-c . e}
+object, you can edit the file by typing @kbd{C-c . e}
(@code{ede-edit-file-target}). You should ``rescan'' the project
afterwards (@pxref{Miscellaneous commands}).
@menu
* ede-cpp-root:: This project marks the root of a C/C++ code project.
* ede-simple subclassing:: Create your own simple project.
-* ede-emacs:: A project for working with Emacs.
-* ede-linux:: A project for working with Linux kernels.
+* ede-emacs:: A project for working with Emacs.
+* ede-linux:: A project for working with Linux kernels.
* Custom Locate:: Customizing how to locate files in a simple project
@end menu
(defun MY-LOAD (dir)
"Load a project of type `cpp-root' for the directory DIR.
Return nil if there isn't one."
- ;; Use your preferred constructin method here.
+ ;; Use your preferred construction method here.
(ede-cpp-root-project "NAME" :file (expand-file-name "FILE" dir)
:locate-fcn 'MYFCN)
)
(add-to-list 'ede-project-class-files
- (ede-project-autoload "cpp-root"
- :name "CPP ROOT"
- :file 'ede-cpp-root
- :proj-file 'MY-FILE-FOR-DIR
+ (ede-project-autoload "cpp-root"
+ :name "CPP ROOT"
+ :file 'ede-cpp-root
+ :proj-file 'MY-FILE-FOR-DIR
:proj-root 'MY-ROOT-FCN
- :load-type 'MY-LOAD
- :class-sym 'ede-cpp-root)
- t)
+ :load-type 'MY-LOAD
+ :class-sym 'ede-cpp-root)
+ t)
@end example
This example only creates an auto-loader, and does not create a new kind
@example
(defvar ede-source-emacs
(ede-sourcecode "ede-emacs-source"
- :name "Emacs Lisp"
- :sourcepattern "\\.el$"
- :garbagepattern '("*.elc"))
+ :name "Emacs Lisp"
+ :sourcepattern "\\.el$"
+ :garbagepattern '("*.elc"))
"Emacs Lisp source code definition.")
@end example
Type: @code{(or null list)} @*
Default Value: @code{(quote ("GNUmakefile.preamble"))}
-The auxilliary makefile for additional variables.
+The auxiliary makefile for additional variables.
Included just before the specific target files.
@refill
Type: @code{(or null list)} @*
Default Value: @code{(quote ("GNUmakefile.postamble"))}
-The auxilliary makefile for additional rules.
+The auxiliary makefile for additional rules.
Included just after the specific target files.
@refill
Type: @code{list} @*
Default Value: @code{nil}
-Auxilliary source files included in this target.
+Auxiliary source files included in this target.
Each of these is considered equivalent to a source file, but it is not
distributed, and each should have a corresponding rule to build it.
@refill
@end deffn
@deffn Method ede-proj-flush-autoconf :AFTER this
-Flush the configure file (current buffer) to accomodate @var{THIS}.
+Flush the configure file (current buffer) to accommodate @var{THIS}.
By flushing, remove any cruft that may be in the file. Subsequent
calls to @dfn{ede-proj-tweak-autoconf} can restore items removed by flush.
@end deffn
@end deffn
@deffn Method ede-proj-tweak-autoconf :AFTER this
-Tweak the configure file (current buffer) to accomodate @var{THIS}.
+Tweak the configure file (current buffer) to accommodate @var{THIS}.
@end deffn
@deffn Method ede-proj-compilers :AFTER obj
@end deffn
@deffn Method ede-proj-flush-autoconf :AFTER this
-Flush the configure file (current buffer) to accomodate @var{THIS}.
+Flush the configure file (current buffer) to accommodate @var{THIS}.
@end deffn
@deffn Method ede-buffer-mine :AFTER this buffer
@end deffn
@deffn Method ede-proj-tweak-autoconf :AFTER this
-Tweak the configure file (current buffer) to accomodate @var{THIS}.
+Tweak the configure file (current buffer) to accommodate @var{THIS}.
@end deffn
@deffn Method ede-update-version-in-source :AFTER this version
@end deffn
@deffn Method ede-proj-flush-autoconf :AFTER this
-Flush the configure file (current buffer) to accomodate @var{THIS}.
+Flush the configure file (current buffer) to accommodate @var{THIS}.
@end deffn
@deffn Method ede-buffer-mine :AFTER this buffer
@end deffn
@deffn Method ede-proj-tweak-autoconf :AFTER this
-Tweak the configure file (current buffer) to accomodate @var{THIS}.
+Tweak the configure file (current buffer) to accommodate @var{THIS}.
@end deffn
@deffn Method ede-update-version-in-source :AFTER this version
@subsubsection Specialized Methods
@deffn Method ede-proj-tweak-autoconf :AFTER this
-Tweak the configure file (current buffer) to accomodate @var{THIS}.
+Tweak the configure file (current buffer) to accommodate @var{THIS}.
@end deffn
@end deffn
@deffn Method project-compile-target-command :AFTER this
-Default target t- use when compling a texinfo file.
+Default target t- use when compiling a texinfo file.
@end deffn
@deffn Method ede-documentation :AFTER this
Default Value: @code{nil}
Emacs regex matching auxiliary source code this target accepts.
-Aux source are source code files needed for compilation, which are not comiled
+Aux source are source code files needed for compilation, which are not compiled
themselves.
@refill
@item :objectextention
Type: @code{string}
-A string which is the extention used for object files.
+A string which is the extension used for object files.
For example, C code uses .o on unix, and Emacs Lisp uses .elc.
@refill
@subsubsection Specialized Methods
@deffn Method ede-proj-flush-autoconf :AFTER this
-Flush the configure file (current buffer) to accomodate @var{THIS}.
+Flush the configure file (current buffer) to accommodate @var{THIS}.
@end deffn
@deffn Method ede-proj-makefile-insert-rules :AFTER this
@end deffn
@deffn Method ede-proj-tweak-autoconf :AFTER this
-Tweak the configure file (current buffer) to accomodate @var{THIS}.
+Tweak the configure file (current buffer) to accommodate @var{THIS}.
@end deffn
@item :objectextention
Type: @code{string}
-A string which is the extention used for object files.
+A string which is the extension used for object files.
For example, C code uses .o on unix, and Emacs Lisp uses .elc.
@refill
@item :objectextention
Type: @code{string}
-A string which is the extention used for object files.
+A string which is the extension used for object files.
For example, C code uses .o on unix, and Emacs Lisp uses .elc.
@refill
@end table
@bye
-
-@ignore
- arch-tag: c9bfdc6e-e6e9-4e87-97f7-d8348342fbf4
-@end ignore
HCoop / bpt / emacs.git / blobdiff