Add .info extension to @setfilename commands in doc/
[bpt/emacs.git] / doc / misc / ede.texi
index 1e1da0f..c61a32c 100644 (file)
@@ -1,5 +1,5 @@
 \input texinfo
-@setfilename ../../info/ede
+@setfilename ../../info/ede.info
 @settitle Emacs Development Environment
 @documentencoding UTF-8
 
@@ -13,7 +13,7 @@ Free Software Foundation, Inc.
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
+Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
 and with the Back-Cover Texts as in (a) below.  A copy of the license
 is included in the section entitled ``GNU Free Documentation License.''
 
@@ -792,6 +792,7 @@ override the default include path and system include path like this:
 (ede-cpp-root-project "NAME" :file "FILENAME"
     :include-path '( "/include" "../include" "/c/include" )
     :system-include-path '( "/usr/include/c++/3.2.2/" )
+    :compile-command "make compile"
     :spp-table '( ("MOOSE" . "")
                   ("CONST" . "const") ) )
 @end example
@@ -809,6 +810,9 @@ The @code{:system-include-path} allows you to specify full directory
 names to include directories where system header files can be found.
 These will be applied to files in this project only.
 
+With @code{:compile-command} you can provide a command which should be
+run when calling @code{ede-compile-project}.
+
 The @code{:spp-table} provides a list of project specific #define
 style macros that are unique to this project, passed in to the
 compiler on the command line, or are in special headers.
@@ -911,6 +915,12 @@ Kernel source tree, and enable EDE project mode for it.
 It pre-populates the C Preprocessor symbol map for reasonable parsing,
 and has an optimized include file identification function.
 
+Through the variables @code{project-linux-build-directory-default} and
+@code{project-linux-architecture-default}, you can set the build
+directory and its architecture, respectively.  The default is to assume that
+the build happens in the source directory and to auto-detect the
+architecture; if the auto-detection fails, you will be asked.
+
 @node ede-generic-project, Custom Locate, ede-linux, Simple projects
 @subsection ede-generic-project
 
@@ -1190,7 +1200,7 @@ until one of them returns true.  The method
 from the autoload.  If it is a string (i.e., a project file name), it
 checks to see if that exists in BUFFER's directory.  If it is a
 function, then it calls that function and expects it to return a file
-name or nil.  If the file exists, then this directory is assumed to be
+name or @code{nil}.  If the file exists, then this directory is assumed to be
 part of a project, and @code{ede-directory-project-p} returns the
 instance of @code{ede-project-autoload} that matched.
 
@@ -1265,11 +1275,11 @@ Return a string that is the name of the target used by a Make system.
 A brief description of the project or target.  This is currently used
 by the @samp{ede-speedbar} interface.
 @item ede-want-file-p
-Return non-nil if a target will accept a given file.
+Return non-@code{nil} if a target will accept a given file.
 It is generally unnecessary to override this.  See the section on source
 code.
 @item ede-buffer-mine
-Return non-nil if a buffer belongs to this target.  Used during
+Return non-@code{nil} if a buffer belongs to this target.  Used during
 association when a file is loaded.  It is generally unnecessary to
 override this unless you keep auxiliary files.
 @end table
@@ -1604,7 +1614,7 @@ Provide a speedbar description for @var{OBJ}.
 @end deffn
 
 @deffn Method ede-map-any-target-p :AFTER this proc
-For project @var{THIS}, map @var{PROC} to all targets and return if any non-nil.
+For project @var{THIS}, map @var{PROC} to all targets and return if any non-@code{nil}.
 Return the first non-@code{nil} value returned by @var{PROC}.
 @end deffn
 
@@ -1758,7 +1768,7 @@ If @var{TARGET} belongs to a subproject, return that project file.
 @end deffn
 
 @deffn Method ede-find-target :AFTER proj buffer
-Fetch the target in @var{PROJ} belonging to @var{BUFFER} or nil.
+Fetch the target in @var{PROJ} belonging to @var{BUFFER} or @code{nil}.
 @end deffn
 
 @deffn Method ede-add-subproject :AFTER proj-a proj-b
@@ -1874,8 +1884,8 @@ The function symbol must take two arguments:
   NAME - The name of the file to find.
   DIR - The directory root for this cpp-root project.
 
-It should return the fully qualified file name passed in from NAME@.  If that file does not
-exist, it should return nil.
+It should return the fully qualified file name passed in from NAME@.
+If that file does not exist, it should return @code{nil}.
 
 @end table
 
@@ -2037,7 +2047,7 @@ Default Value: @code{nil}
 Non-@code{nil} if this is a metasubproject.
 Usually, a subproject is determined by a parent project.  If multiple top level
 projects are grouped into a large project not maintained by EDE, then you need
-to set this to non-nil.  The only effect is that the @code{dist} rule will then avoid
+to set this to non-@code{nil}.  The only effect is that the @code{dist} rule will then avoid
 making a tar file.
 
 @end table
@@ -2271,7 +2281,7 @@ Default Value: @code{nil}
 Non-@code{nil} if this is a metasubproject.
 Usually, a subproject is determined by a parent project.  If multiple top level
 projects are grouped into a large project not maintained by EDE, then you need
-to set this to non-nil.  The only effect is that the @code{dist} rule will then avoid
+to set this to non-@code{nil}.  The only effect is that the @code{dist} rule will then avoid
 making a tar file.
 
 @end table