Revision: 402 Author: ntrel Date: 2006-06-03 13:46:23 -0700 (Sat, 03 Jun 2006) ViewCVS: http://svn.sourceforge.net/geany/?rev=402&view=rev
Log Message: ----------- Added Build System section
Modified Paths: -------------- trunk/ChangeLog trunk/doc/geany.docbook Modified: trunk/ChangeLog =================================================================== --- trunk/ChangeLog 2006-06-03 17:14:09 UTC (rev 401) +++ trunk/ChangeLog 2006-06-03 20:46:23 UTC (rev 402) @@ -8,6 +8,7 @@ 2006-06-03 Nick Treleaven nick.treleaven@btinternet.com
* doc/geany.docbook: More minor corrections/rewording. + Added Build System section.
2006-06-02 Enrico Troeger enrico.troeger@uvena.de
Modified: trunk/doc/geany.docbook =================================================================== --- trunk/doc/geany.docbook 2006-06-03 17:14:09 UTC (rev 401) +++ trunk/doc/geany.docbook 2006-06-03 20:46:23 UTC (rev 402) @@ -623,6 +623,113 @@ </para> </section> </section> + <section id="buildsystem"> + <title>Build System</title> + <para> + <application>&app;</application> has an integrated build system. When you compile, + link, syntax check or otherwise process a source file, the output will be captured + in the Compiler notebook tab of the messages window (assuming you have it visible). + If there are any warnings or errors with line numbers shown in the Compiler output tab, + you can double click on them and <application>&app;</application> will switch to + the relevant source file (if it is open) and mark the line number so the problem + can be corrected. + </para> + <para> + Depending on the current file's filetype, the Build menu will contain the following + items: + <itemizedlist> + <listitem><para>Compile</para></listitem> + <listitem><para>Build</para></listitem> + <listitem><para>Build with "make"</para></listitem> + <listitem><para>Build with make (custom target)</para></listitem> + <listitem><para>Execute</para></listitem> + <listitem><para>Set Includes and Arguments</para></listitem> + </itemizedlist> + </para> + <section> + <title>Compile</title> + <para> + By default, the Compile command is setup to build binary object files for + compilable languages such as C and C++. + </para> + <para> + Java will be compiled to + class file bytecode. Interpreted languages such as Perl, Python, Ruby will + compile to bytecode if the language supports it, or will run a syntax check, + or failing that will run the file in the language interpreter. + </para> + </section> + <section> + <title>Build</title> + <para> + For compilable languages such as C and C++, the Build command will link the + current source file's equivalent object file into an executable. If the object + file does not exist, the source will be compiled and linked in one step, + producing just the executable binary. + </para> + <para> + Interpreted languages do not use the Build command. + </para> + </section> + <section> + <title>Build with "make"</title> + <para> + This effectively runs "make all" in the same directory as the current file. + The Make tool path must be correctly set in the Tools tab of the Preferences + dialog. + </para> + </section> + <section> + <title>Build with make (custom target)</title> + <para> + This is identical to running 'Build with "make"' but you will be prompted + for the make target name to be passed to the Make tool. For example, + typing 'clean' in the dialog prompt will run "make clean" (but using the + full path to the Make tool set in Preferences). + </para> + </section> + <section> + <title>Execute</title> + <para> + Execute will run the corresponding executable file, shell script or interpreted + script in a terminal window. Note that the Terminal tool path must be correctly + set in the Tools tab of the Preferences dialog - you can use any terminal + program that runs a Bourne compatible shell. + After your program or script has finished executing, you will be prompted to + press the return key. This allows you to review any text output from the program. + </para> + </section> + <section> + <title>Set Includes and Arguments</title> + <para> + By default the Compile and Build commands invoke the compiler and linker with + only the basic arguments needed by all programs. + Using Set Includes and Arguments you can add any include + paths and compile flags for the compiler, any library names and paths for the + linker, and any arguments you want to use when running Execute. Note that if + you are using the Build command to compile and link in one step, you will need + to set both the compiler arguments and the linker arguments in the linker + command setting. + </para> + <para> + These settings are not saved when <application>&app;</application> is shut + down. See below for how to set permanent arguments. + </para> + <para> + If you need complex settings for your build system, or several different + settings, then writing a Makefile and using 'Build with "make"' is recommended. + </para> + </section> + <section> + <title>File type configuration settings</title> + <para> + You can set the commands to run for compiling, building or executing + by opening the relevant <filename>filetypes.*</filename> configuration file, + and checking the build_settings section. See <xref linkend="filetypes"/> for more + information. + </para> + </section> + </section> <section id="keybindings"> <title>Keybindings</title> <para>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.