diff options
| author | David Engster | 2014-03-18 08:13:51 +0100 |
|---|---|---|
| committer | David Engster | 2014-03-18 08:13:51 +0100 |
| commit | 636fd6bc0efc8616e02382a013184f2adf592a8e (patch) | |
| tree | 85320673509b3d11688a88ccea9fcc440f20d2ea | |
| parent | 2b7858ecbd57f16d0a20906dd792fd96049c5952 (diff) | |
| download | emacs-636fd6bc0efc8616e02382a013184f2adf592a8e.tar.gz emacs-636fd6bc0efc8616e02382a013184f2adf592a8e.zip | |
ede.texi: Remove documentation for features only in CEDET upstream.
* ede.texi (Project Local Variables): Remove reference to
`ede-java-root' and the example using it.
(Android projects, ede-java-root): Remove nodes since they are
only in CEDET upstream (Bug#17030). All nodes updated.
| -rw-r--r-- | doc/misc/ChangeLog | 7 | ||||
| -rw-r--r-- | doc/misc/ede.texi | 141 |
2 files changed, 13 insertions, 135 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 4fac93537a3..4301afb60ea 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,10 @@ | |||
| 1 | 2014-03-18 David Engster <deng@randomsample.de> | ||
| 2 | |||
| 3 | * ede.texi (Project Local Variables): Remove reference to | ||
| 4 | `ede-java-root' and the example using it. | ||
| 5 | (Android projects, ede-java-root): Remove nodes since they are | ||
| 6 | only in CEDET upstream (Bug#17030). All nodes updated. | ||
| 7 | |||
| 1 | 2014-03-12 Glenn Morris <rgm@gnu.org> | 8 | 2014-03-12 Glenn Morris <rgm@gnu.org> |
| 2 | 9 | ||
| 3 | * eww.texi (History and Acknowledgments): | 10 | * eww.texi (History and Acknowledgments): |
diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index 16c70a5647e..1e1da0fddf9 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi | |||
| @@ -598,17 +598,6 @@ the format is an association list. For example: | |||
| 598 | (compile-command . "make -f MyCustomMakefile all"))) | 598 | (compile-command . "make -f MyCustomMakefile all"))) |
| 599 | @end example | 599 | @end example |
| 600 | 600 | ||
| 601 | The same is true when you use project-local variables with | ||
| 602 | @ref{ede-java-root}. For example: | ||
| 603 | |||
| 604 | @example | ||
| 605 | (ede-java-root-project "SOMENAME" | ||
| 606 | :file "/dir/to/some/file" | ||
| 607 | :local-variables | ||
| 608 | '((grep-command . "grep -nHi -e ") | ||
| 609 | (compile-command . "ant"))) | ||
| 610 | @end example | ||
| 611 | |||
| 612 | @node EDE Project Features, , Project Local Variables, Modifying your project | 601 | @node EDE Project Features, , Project Local Variables, Modifying your project |
| 613 | @section EDE Project Features | 602 | @section EDE Project Features |
| 614 | 603 | ||
| @@ -724,12 +713,10 @@ To activate the speedbar in this mode, type @kbd{C-c . s} | |||
| 724 | @menu | 713 | @menu |
| 725 | * Make and Automake projects:: Project types of @samp{ede-project} | 714 | * Make and Automake projects:: Project types of @samp{ede-project} |
| 726 | * Automake direct projects:: Project interface on hand-written automake files. | 715 | * Automake direct projects:: Project interface on hand-written automake files. |
| 727 | * Android projects:: Projects for Android development | ||
| 728 | * Arduino projects:: Projects for Arduino sketches | ||
| 729 | * Simple projects:: Projects @ede{} doesn't manage. | 716 | * Simple projects:: Projects @ede{} doesn't manage. |
| 730 | @end menu | 717 | @end menu |
| 731 | 718 | ||
| 732 | @node Make and Automake projects | 719 | @node Make and Automake projects, Automake direct projects, Miscellaneous commands, Miscellaneous commands |
| 733 | @section Make and Automake projects | 720 | @section Make and Automake projects |
| 734 | 721 | ||
| 735 | A project of @samp{ede-project} type creates a file called | 722 | A project of @samp{ede-project} type creates a file called |
| @@ -741,7 +728,7 @@ in @samp{Makefile} mode, then this project will autogenerate a | |||
| 741 | routines will also import and maintain a configure.am script and a | 728 | routines will also import and maintain a configure.am script and a |
| 742 | host of other files required by Automake. | 729 | host of other files required by Automake. |
| 743 | 730 | ||
| 744 | @node Automake direct projects | 731 | @node Automake direct projects, Simple projects, Make and Automake projects, Miscellaneous commands |
| 745 | @section Automake direct projects | 732 | @section Automake direct projects |
| 746 | 733 | ||
| 747 | The project type that reads @file{Makefile.am} directly is derived | 734 | The project type that reads @file{Makefile.am} directly is derived |
| @@ -751,39 +738,7 @@ distributed independently. This mode eventually became @ede{}. The | |||
| 751 | not generate them automatically, or create new ones. As such, it is | 738 | not generate them automatically, or create new ones. As such, it is |
| 752 | useful as a browsing tool, or as maintenance in managing file lists. | 739 | useful as a browsing tool, or as maintenance in managing file lists. |
| 753 | 740 | ||
| 754 | @node Android projects | 741 | @node Simple projects, , Automake direct projects, Miscellaneous commands |
| 755 | @section Android projects | ||
| 756 | |||
| 757 | An Android project of type @samp{ede-android-project} will detect and | ||
| 758 | support development of Android apps. Android projects use an | ||
| 759 | @file{AndroidManifest.xml} file. Always load your Manifest first in a | ||
| 760 | running Emacs to make sure the project is identified correctly. | ||
| 761 | |||
| 762 | Android projects can be created with @code{ede-new} but depend on a | ||
| 763 | correctly configured Android SDK via @cedet{} support. | ||
| 764 | |||
| 765 | @defun cedet-android-sdk-root | ||
| 766 | @anchor{cedet-android-sdk-root} | ||
| 767 | The root to the Android @var{SDK}. | ||
| 768 | @end defun | ||
| 769 | |||
| 770 | Android projects support different configurations including compile, | ||
| 771 | and install, which will upload a program to your Android device. It | ||
| 772 | also supports several debugging tools via @file{android.el}. | ||
| 773 | |||
| 774 | @node Arduino projects | ||
| 775 | @section Arduino projects | ||
| 776 | |||
| 777 | An arduino project of type @samp{ede-arduino-project} will read your | ||
| 778 | @file{~/.arduino/preferences.txt} file, and identify your sketches. | ||
| 779 | You will still need the Arduino IDE to set up your preferences and | ||
| 780 | locate your arduino. After quitting the IDE, Emacs will be able to | ||
| 781 | find your sketches, compile them, and upload them to your arduino. | ||
| 782 | |||
| 783 | If you have the @file{arduino} command on your path, @ede{} will be | ||
| 784 | able to find your SDK and compile your programs. | ||
| 785 | |||
| 786 | @node Simple projects | ||
| 787 | @section Simple Projects | 742 | @section Simple Projects |
| 788 | 743 | ||
| 789 | There is a wide array of simple projects. In this case a simple | 744 | There is a wide array of simple projects. In this case a simple |
| @@ -795,14 +750,13 @@ belonging to a project, but doesn't provide many features of a typical | |||
| 795 | 750 | ||
| 796 | @menu | 751 | @menu |
| 797 | * ede-cpp-root:: This project marks the root of a C/C++ code project. | 752 | * ede-cpp-root:: This project marks the root of a C/C++ code project. |
| 798 | * ede-java-root:: This project marks the root of a Java project. | ||
| 799 | * ede-emacs:: A project for working with Emacs. | 753 | * ede-emacs:: A project for working with Emacs. |
| 800 | * ede-linux:: A project for working with Linux kernels. | 754 | * ede-linux:: A project for working with Linux kernels. |
| 801 | * ede-generic-project:: A project type for wrapping build systems with EDE. | 755 | * ede-generic-project:: A project type for wrapping build systems with EDE. |
| 802 | * Custom Locate:: Customizing how to locate files in a simple project | 756 | * Custom Locate:: Customizing how to locate files in a simple project |
| 803 | @end menu | 757 | @end menu |
| 804 | 758 | ||
| 805 | @node ede-cpp-root, ede-java-root, Simple projects, Simple projects | 759 | @node ede-cpp-root, ede-emacs, Simple projects, Simple projects |
| 806 | @subsection ede-cpp-root | 760 | @subsection ede-cpp-root |
| 807 | 761 | ||
| 808 | The @code{ede-cpp-root} project type allows you to create a single | 762 | The @code{ede-cpp-root} project type allows you to create a single |
| @@ -939,90 +893,7 @@ of project. | |||
| 939 | @xref{ede-cpp-root-project}, for details about the class that defines | 893 | @xref{ede-cpp-root-project}, for details about the class that defines |
| 940 | the @code{ede-cpp-root} project type. | 894 | the @code{ede-cpp-root} project type. |
| 941 | 895 | ||
| 942 | @node ede-java-root, ede-emacs, ede-cpp-root, Simple projects | 896 | @node ede-emacs, ede-linux, ede-cpp-root, Simple projects |
| 943 | @subsection ede-java-root | ||
| 944 | |||
| 945 | Much like the project type @ref{ede-cpp-root}, the java variant is | ||
| 946 | can be setup in your @file{.emacs} file and just marks a directory as | ||
| 947 | the root of a java source tree. | ||
| 948 | |||
| 949 | The @code{ede-java-root} project class knows a few things about Java | ||
| 950 | projects. In particular, you can use it to control your classpath at | ||
| 951 | both the system level, and for your project. If it is insufficient, | ||
| 952 | you can subclass @code{ede-java-root-project} and add your own tweaks | ||
| 953 | in just a few lines. See @ref{ede-cpp-root} for an example using the | ||
| 954 | C++ variant. | ||
| 955 | |||
| 956 | In the most basic case, add this to your @file{.emacs} file, modifying | ||
| 957 | appropriate bits as needed. | ||
| 958 | |||
| 959 | @example | ||
| 960 | (ede-java-root-project "SOMENAME" :file "/dir/to/some/file" :srcroot '("src")) | ||
| 961 | @end example | ||
| 962 | |||
| 963 | Replace @var{SOMENAME} with whatever name you want, and the filename | ||
| 964 | to an actual file at the root of your project. It might be a | ||
| 965 | Makefile, a README file. Whatever. It doesn't matter. It's just a | ||
| 966 | key to hang the rest of @ede{} off of. | ||
| 967 | |||
| 968 | Replace the value of :srcroot with a list of directories under the | ||
| 969 | project root which contains Java sources. For example, if you have: | ||
| 970 | |||
| 971 | @example | ||
| 972 | ~/myprojects/P1/ | ||
| 973 | ~/myprojects/P1/src/ | ||
| 974 | ~/myprojects/P1/src/com/ericsoft/MyCode.java | ||
| 975 | ~/myprojects/P1/doc/ | ||
| 976 | @end example | ||
| 977 | |||
| 978 | Then @file{src} represents the directory under which all your Java | ||
| 979 | code is. It is important that @file{src} is one step above the | ||
| 980 | directory that is the base of your package name, such as | ||
| 981 | @file{com/ericsoft} in the example above so that new files can be | ||
| 982 | discovered via fully qualified name. You can have multiple such | ||
| 983 | directories in one project, and each will be accessible. | ||
| 984 | |||
| 985 | You can specify your classpath like this: | ||
| 986 | |||
| 987 | @example | ||
| 988 | (ede-java-root-project "NAME" :file "FILENAME" | ||
| 989 | :srcroot '("src") | ||
| 990 | :classpath '("/absolute/path.jar") | ||
| 991 | :localclasspath '( "/relative/path.jar" )) | ||
| 992 | @end example | ||
| 993 | |||
| 994 | In this example, @code{:classpath} specifies absolute paths somewhere | ||
| 995 | on your system, and the explicit jar or source root directories | ||
| 996 | @semantic{} will search when performing completions. | ||
| 997 | |||
| 998 | The @code{:localclasspath} is like @code{:classpath}, but it will | ||
| 999 | contain path names relative to the root of your project. | ||
| 1000 | |||
| 1001 | If you want to override the file-finding tool with your own | ||
| 1002 | function you can do this: | ||
| 1003 | |||
| 1004 | @example | ||
| 1005 | (ede-java-root-project "NAME" :file "FILENAME" :locate-fcn 'MYFCN) | ||
| 1006 | @end example | ||
| 1007 | |||
| 1008 | Where @var{MYFCN} is a symbol for a function. The locate function can | ||
| 1009 | be used in place of @code{ede-expand-filename} so you can quickly | ||
| 1010 | customize your custom target to use specialized local routines instead | ||
| 1011 | of the default @ede{} routines. The function symbol must take two | ||
| 1012 | arguments: | ||
| 1013 | |||
| 1014 | @table @var | ||
| 1015 | @item NAME | ||
| 1016 | The name of the file to find. | ||
| 1017 | @item DIR | ||
| 1018 | The directory root for this java-root project. | ||
| 1019 | @end table | ||
| 1020 | |||
| 1021 | If you would like to create your Java projects dynamically, instead of | ||
| 1022 | putting them all in your @file{.emacs}, you can do that too. See | ||
| 1023 | @ref{ede-cpp-root} for details that can be applied to this project type. | ||
| 1024 | |||
| 1025 | @node ede-emacs, ede-linux, ede-java-root, Simple projects | ||
| 1026 | @subsection ede-emacs | 897 | @subsection ede-emacs |
| 1027 | 898 | ||
| 1028 | The @code{ede-emacs} project automatically identifies an Emacs source | 899 | The @code{ede-emacs} project automatically identifies an Emacs source |
| @@ -4395,7 +4266,7 @@ For example, C code uses .o on unix, and Emacs Lisp uses .elc. | |||
| 4395 | @end table | 4266 | @end table |
| 4396 | @end table | 4267 | @end table |
| 4397 | 4268 | ||
| 4398 | @node GNU Free Documentation License, , Extending EDE, Top | 4269 | @node GNU Free Documentation License, , Extending EDE, Top |
| 4399 | @appendix GNU Free Documentation License | 4270 | @appendix GNU Free Documentation License |
| 4400 | @include doclicense.texi | 4271 | @include doclicense.texi |
| 4401 | 4272 | ||