[anjuta] manual: Add documentation for build plugin
- From: Sebastien Granjoux <sgranjoux src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [anjuta] manual: Add documentation for build plugin
- Date: Sat, 2 Jul 2011 18:52:54 +0000 (UTC)
commit 248c56de623fa23ba448491398ee05d76fe96c3c
Author: SÃbastien Granjoux <seb sfo free fr>
Date: Sat Jul 2 19:32:58 2011 +0200
manual: Add documentation for build plugin
manuals/anjuta-manual/C/anjuta-build-build.page | 29 ------
.../anjuta-manual/C/anjuta-build-configure.page | 26 -----
.../anjuta-manual/C/anjuta-build-distribute.page | 25 -----
.../C/{anjuta-build-run.page => anjuta-run.page} | 11 +-
manuals/anjuta-manual/C/autotools-build-build.page | 82 ++++++++++++++++
manuals/anjuta-manual/C/autotools-build-clean.page | 73 +++++++++++++++
.../anjuta-manual/C/autotools-build-compile.page | 70 ++++++++++++++
.../C/autotools-build-configure-dialog.page | 92 ++++++++++++++++++
.../anjuta-manual/C/autotools-build-configure.page | 98 ++++++++++++++++++++
.../C/autotools-build-distribute.page | 37 ++++++++
.../anjuta-manual/C/autotools-build-install.page | 84 +++++++++++++++++
.../anjuta-manual/C/autotools-build-plugin.page | 60 ++++++++++++
.../C/autotools-build-preferences-dialog.page | 63 +++++++++++++
manuals/anjuta-manual/C/full-index.page | 6 +-
manuals/anjuta-manual/C/index.page | 10 +-
manuals/anjuta-manual/C/widget-index.page | 17 ++++
16 files changed, 690 insertions(+), 93 deletions(-)
---
diff --git a/manuals/anjuta-manual/C/anjuta-build-run.page b/manuals/anjuta-manual/C/anjuta-run.page
similarity index 75%
rename from manuals/anjuta-manual/C/anjuta-build-run.page
rename to manuals/anjuta-manual/C/anjuta-run.page
index b4280c9..820dac6 100644
--- a/manuals/anjuta-manual/C/anjuta-build-run.page
+++ b/manuals/anjuta-manual/C/anjuta-run.page
@@ -1,14 +1,14 @@
<page xmlns="http://projectmallard.org/1.0/";
type="topic" style="task"
- id="anjuta-build-run">
+ id="anjuta-run">
<info xmlns:facet="http://projectmallard.org/facet/1.0/";>
<facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
- <link type="guide" xref="index#anjuta-build" group="second"/>
+ <link type="guide" xref="index#anjuta-debug" group="second"/>
<revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
<credit type="author">
- <name>Johannes Schmid</name>
- <email>jhs gnome org</email>
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
</credit>
</info>
@@ -22,4 +22,5 @@
<title>Running in the terminal</title>
</section>
-</page>
\ No newline at end of file
+</page>
+
diff --git a/manuals/anjuta-manual/C/autotools-build-build.page b/manuals/anjuta-manual/C/autotools-build-build.page
new file mode 100644
index 0000000..3627aec
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-build.page
@@ -0,0 +1,82 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-build">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <link type="guide" xref="index#anjuta-build" group="third"/>
+ <link type="seealso" xref="autotools-build-plugin"/>
+ <link type="seealso" xref="autotools-build-preferences-dialog"/>
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Build targets or project.
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Build targets</title>
+ <p>
+ A target is a file created from source files, typically it is a program
+ or a library, but it could be a documentation if some processing is
+ needed.
+ </p>
+ <p>
+ The build command compile all needed sources files and link them
+ with possibly some other files, like libraries, in order to create the target.
+ If some source files are already compiled and haven't been modified,
+ they are not be recompiled to gain time. There are several ways
+ to trigger a build.
+ </p>
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Build</gui></guiseq> or press <key>F7</key> to build all
+ target in the same directory than the current edited file.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Build Project</gui></guiseq> or press <key>Shift+F7</key>
+ to build the complete project, all subdirectories are built recursively.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>file manager pane</gui>, select a file or a directory.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on the right mouse button to make the <gui>file manager context menu</gui>
+ appears and select <guiseq><gui>Build</gui><gui>Build</gui></guiseq>
+ to build all targets in the directory currently selected or the parent directory of the
+ currently selected file.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>project manager pane</gui>, select a source file or a target.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on the right mouse button to make the <gui>project manager context menu</gui>
+ appears and select <guiseq><gui>Build</gui><gui>Build</gui></guiseq>
+ to build all targets in the directory containing the currently selected file or target.
+ </p>
+ </item>
+ </steps>
+
+</page>
+
diff --git a/manuals/anjuta-manual/C/autotools-build-clean.page b/manuals/anjuta-manual/C/autotools-build-clean.page
new file mode 100644
index 0000000..7f5c837
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-clean.page
@@ -0,0 +1,73 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-clean">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <link type="guide" xref="index#anjuta-build" group="fourth"/>
+ <link type="seealso" xref="autotools-build-plugin"/>
+ <link type="seealso" xref="autotools-build-preferences-dialog"/>
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Remove built files.
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Clean targets</title>
+
+ <p>It can be useful to delete all files created by the build process. By
+ example if the all dependencies are not taken into account and
+ a modified file does not trigger a recompiling as it should, deleting
+ all files will fix this. There are several way to do this</p>
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Clean</gui></guiseq> to delete all files build in the
+ same directory than the current edited file.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Clean Project</gui></guiseq> to delete all project built files,
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>file manager pane</gui>, select a file or a directory.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on the right mouse button to make the <gui>file manager context menu</gui>
+ appears and select <guiseq><gui>Build</gui><gui>Clean</gui></guiseq>
+ to delete all files built in the directory currently selected or the parent directory of the
+ currently selected file.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>project manager pane</gui>, select a source file or a target.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on the right mouse button to make the <gui>project manager context menu</gui>
+ appears and select <guiseq><gui>Build</gui><gui>Clean</gui></guiseq>
+ to delete all built files in the directory containing the currently selected file or target.
+ </p>
+ </item>
+ </steps>
+
+</page>
diff --git a/manuals/anjuta-manual/C/autotools-build-compile.page b/manuals/anjuta-manual/C/autotools-build-compile.page
new file mode 100644
index 0000000..49e0aa4
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-compile.page
@@ -0,0 +1,70 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-compile">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <link type="guide" xref="index#anjuta-build" group="second"/>
+ <link type="seealso" xref="autotools-build-plugin"/>
+ <link type="seealso" xref="autotools-build-preferences-dialog"/>
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Compile files.
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Compile files</title>
+
+ <p>
+ Most programming language allow you to compile an individual source file.
+ It reads the file, checks for errors and convert into an intermediate
+ object file. Most errors happens in this step, so it is useful to compile a file
+ after modifying it to check for errors. There are several ways to do it.
+ </p>
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Compile</gui></guiseq> or press <key>F9</key> to compile
+ the current edited file.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>file manager pane</gui>, select a file.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on the right mouse button to make the <gui>file manager context menu</gui>
+ appears and select <guiseq><gui>Build</gui><gui>Compile</gui></guiseq>
+ to compile the file currently selected in the <gui>file manager pane</gui>.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>project manager pane</gui>, select a source file.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on the right mouse button to make the <gui>project manager context menu</gui>
+ appears and select <guiseq><gui>Build</gui><gui>Compile</gui></guiseq>
+ to compile the file currently selected in the <gui>project manager pane</gui>.
+ </p>
+ </item>
+ </steps>
+ <note style="tip">
+ <p>You do not need to save your file before compiling it, it will be done
+ automatically by <app>Anjuta</app> if needed.</p>
+ </note>
+
+</page>
diff --git a/manuals/anjuta-manual/C/autotools-build-configure-dialog.page b/manuals/anjuta-manual/C/autotools-build-configure-dialog.page
new file mode 100644
index 0000000..dc9fd95
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-configure-dialog.page
@@ -0,0 +1,92 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-configure-dialog">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <facet:tag key="all-widgets" value="whatever"/> <!--Include page in index-->
+ <link type="seealso" xref="autotools-project-backend"/>
+ <link type="seealso" xref="autotools-build-configure"/>
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Autotools configure dialog
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Autotools Configure Dialog</title>
+
+ <p>
+ The <gui>Configure</gui> dialog allows you to set the following options
+ and configure the project.
+ </p>
+
+ <terms>
+ <item>
+ <title><gui>Regenerate Project</gui></title>
+ <p>
+ If checked, the project will be completely regenerated, else only the
+ configure step is done. <app>Anjuta</app> automatically checks this
+ check box when needed so you can leave it in its current state.
+ </p>
+ </item>
+ <item>
+ <title><gui>Configuration</gui></title>
+ <p>
+ You can have several configurations having their own options and build
+ directory, this text box allows to name them.
+ Typically you have already defined a Default configuration,
+ a Debug configuration making programs easier to debug (keeping
+ intermediate variables and code ordering) and
+ an Optimized configuration generating faster programs but increasing
+ build time. You can define additional custom configurations.
+ </p>
+ </item>
+ <item>
+ <title><gui>Build Directory</gui></title>
+ <p>
+ Select here the build directory, it can be the project directory
+ or a subdirectory. This is particularly useful when switching between
+ different configurations to avoid rebuilding the whole project.
+ </p>
+ <note style="advanced">
+ <p>
+ With autotools, you cannot have one configuration using a different
+ directory if you already have one configuration using the project
+ directory. You need to remove it first.
+ </p>
+ </note>
+ <note style="bug">
+ <p>
+ Some autotools project cannot be built outside the project directory.
+ You can still use different configurations but they all have to use the
+ project directory and everything will be recompiled on each change
+ of the configuration.
+ </p>
+ </note>
+ </item>
+ <item>
+ <title><gui>Configure Options</gui></title>
+ <p>
+ This text box list all command line arguments used by the configure step.
+ All arguments are separated by spaces and must be quoted if they
+ contains a space. Each configuration fills this text box with default values
+ that you can modify.
+ </p>
+ <note style="advanced">
+ <p>
+ Each autotools project supports a common list of arguments but can
+ have specify arguments. You can have a list of all accepted arguments
+ by running <cmd>configure --help</cmd> on the command line. You need
+ to have configured your project at least one time to have the
+ <cmd>configure</cmd> script.
+ </p>
+ </note>
+ </item>
+ </terms>
+
+</page>
+
diff --git a/manuals/anjuta-manual/C/autotools-build-configure.page b/manuals/anjuta-manual/C/autotools-build-configure.page
new file mode 100644
index 0000000..5e10dfc
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-configure.page
@@ -0,0 +1,98 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-configure">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <link type="guide" xref="index#anjuta-build" group="first"/>
+ <link type="seealso" xref="autotools-project-backend"/>
+ <link type="seealso" xref="autotools-build-plugin"/>
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Configure an autotools project and manage configurations.
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Configure a project</title>
+
+ <p>
+ Before compiling and building files, an autotools project has to be
+ configured. This step is needed to set global options, to check that
+ all required libraries and programs are installed on your system and
+ to generate appropriate build scripts.
+ </p>
+
+ <section>
+ <title>Configure the project</title>
+
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Configure Project...</gui></guiseq>.
+ </p>
+ </item>
+ <item>
+ <p>
+ Keep the default configuration, select a new configuration or create
+ a new one. You can inspect and modify all configuration options.
+ See <link xref="autotools-build-configure-dialog"/> for more information.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on <gui>Execute</gui> to configure the project.
+ </p>
+ </item>
+ </steps>
+
+ <p>
+ The configuration could fail if some libraries or programs are not installed
+ or do not have the right version. The error message tell you what is missing.
+ </p>
+ </section>
+
+ <section>
+ <title>Change the configuration</title>
+
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Select Configuration</gui><gui>Another configuration</gui></guiseq>.
+ </p>
+ </item>
+ </steps>
+
+ <p>
+ If the project has not been already configured, it will be automatically
+ configured before building any file.
+ </p>
+
+ </section>
+
+ <section>
+ <title>Remove configuration</title>
+
+ <p>
+ It is a like cleaning the project but it removes even more files. You
+ need to re-configure your project to build it afterward.
+ </p>
+
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Remove Configuration</gui></guiseq>.
+ </p>
+ </item>
+ </steps>
+
+ </section>
+
+</page>
+
diff --git a/manuals/anjuta-manual/C/autotools-build-distribute.page b/manuals/anjuta-manual/C/autotools-build-distribute.page
new file mode 100644
index 0000000..cba1a32
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-distribute.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-distribute">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <link type="guide" xref="index#anjuta-build" group="sixth"/>
+ <link type="seealso" xref="autotools-build-plugin"/>
+ <link type="seealso" xref="autotools-build-preferences-dialog"/>
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Create a distribution package.
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Create a distribution package</title>
+
+ <p>The standard way to distribute a autotools project is as a compressed
+ tar archive containing all source files. The user will have to decompress it, then
+ compile and install it on his system using the command sequence
+ <cmd>configure</cmd>, <cmd>make</cmd> and <cmd>make install</cmd>.
+ </p>
+
+ <steps>
+ <item>
+ <p>From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Build Tarball</gui></guiseq> to create a source distribution package.
+ </p>
+ </item>
+ </steps>
+
+</page>
+
diff --git a/manuals/anjuta-manual/C/autotools-build-install.page b/manuals/anjuta-manual/C/autotools-build-install.page
new file mode 100644
index 0000000..e0da55a
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-install.page
@@ -0,0 +1,84 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-install">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <link type="guide" xref="index#anjuta-build" group="fifth"/>
+ <link type="seealso" xref="autotools-build-plugin"/>
+ <link type="seealso" xref="autotools-build-preferences-dialog"/>
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Install targets or project.
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Install targets</title>
+
+ <p>Unless your project is very simple, it needs some data files like user
+ interface description files. These files are typically copied in standard
+ directories and read from there. It means that you cannot run your program
+ from the build directory. You need to install it in order to copy all these
+ files in the final place, by example in a subdirectory of <file>/usr/local</file>.
+ </p>
+
+ <p>There are several possibilities to install targets or a project.</p>
+
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Install</gui></guiseq> to install all files in the
+ same directory than the current edited file.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>main menu</gui>, select <guiseq><gui>Build</gui>
+ <gui>Install Project</gui></guiseq> to install all project files,
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>file manager pane</gui>, select a file or a directory.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on the right mouse button to make the <gui>file manager context menu</gui>
+ appears and select <guiseq><gui>Build</gui><gui>Install</gui></guiseq>
+ to install all files in the directory currently selected or the parent directory of the
+ currently selected file.
+ </p>
+ </item>
+ </steps>
+ <steps>
+ <item>
+ <p>
+ From the <gui>project manager pane</gui>, select a source file or a target.
+ </p>
+ </item>
+ <item>
+ <p>
+ Click on the right mouse button to make the <gui>project manager context menu</gui>
+ appears and select <guiseq><gui>Build</gui><gui>Install</gui></guiseq>
+ to install all files in the directory containing the currently selected file or target.
+ </p>
+ </item>
+ </steps>
+
+ <note style="tip">
+ <p>If you install the program in a system directory, you can have to use
+ <cmd>su</cmd> or <cmd>sudo</cmd> to have enough right.
+ See <link xref="autotools-build-preferences-dialog"/> for more information.</p>
+ </note>
+
+</page>
diff --git a/manuals/anjuta-manual/C/autotools-build-plugin.page b/manuals/anjuta-manual/C/autotools-build-plugin.page
new file mode 100644
index 0000000..16a60f3
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-plugin.page
@@ -0,0 +1,60 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-plugin">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Autotools build plugin
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Autotools build plugin</title>
+
+ <p>
+ This plugin is targeted at autotools projects but as they use make it is
+ useful for other kind of projects using make.
+ </p>
+
+ <section>
+ <title>Make command used</title>
+ <p>Here is a list of the targets used by the plugin. They are implemented
+ in all autotools projects but you need to implement them if you use a custom
+ makefile.</p>
+ <terms>
+ <item>
+ <title><cmd>make <var>object_file_name</var></cmd></title>
+ <p>Use to compile an source file. The object file name is found by replacing
+ the source file extension with the corresponding object extension.</p>
+ </item>
+ <item>
+ <title><cmd>make</cmd></title>
+ <p>Use to build all targets in a directory.</p>
+ </item>
+ <item>
+ <title><cmd>make install</cmd></title>
+ <p>Use to install all targets in a directory.</p>
+ </item>
+ <item>
+ <title><cmd>make clean</cmd></title>
+ <p>Use to delete all file built in a directory.</p>
+ </item>
+ <item>
+ <title><cmd>make dist</cmd></title>
+ <p>Use to build a distributation package, called only in the project directory.</p>
+ </item>
+ </terms>
+
+ <note style="tip">
+ <p>As make comes with default rules allowing it to compile and link a C
+ program without needing a makefile. You can compile a C program
+ from a single source file without a makefile nor a project.</p>
+ </note>
+ </section>
+
+</page>
diff --git a/manuals/anjuta-manual/C/autotools-build-preferences-dialog.page b/manuals/anjuta-manual/C/autotools-build-preferences-dialog.page
new file mode 100644
index 0000000..2a1ea51
--- /dev/null
+++ b/manuals/anjuta-manual/C/autotools-build-preferences-dialog.page
@@ -0,0 +1,63 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="autotools-build-preferences-dialog">
+
+ <info xmlns:facet="http://projectmallard.org/facet/1.0/";>
+ <facet:tag key="all-pages" value="whatever"/> <!--Include page in index-->
+ <facet:tag key="all-widgets" value="whatever"/> <!--Include page in index-->
+ <link type="seealso" xref="autotools-build-plugin"/>
+ <revision pkgversion="3.0" version="0.1" date="2011-03-27" status="incomplete"/>
+ <desc>
+ Autotools build preferences dialog.
+ </desc>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Autotools Build Preferences Dialog</title>
+
+ <p>
+ The dialog allows you to set global options for building files.
+ </p>
+
+ <terms>
+ <item>
+ <title><gui>Run several commands at a time</gui></title>
+ <p><app>make</app> is able to run several compilations at the same time.
+ It decrease the build time when having a multi-core processor but could
+ trigger some issues so this can be enabled or disabled with this check box.</p>
+ </item>
+ <item>
+ <title><gui>Continue on errors</gui></title>
+ <p>By default <app>make</app> stops as soon as it gets an error, it can be
+ faster to continue and get errors for all files in one step. You have to check this
+ check box to get this behavior.</p>
+ </item>
+ <item>
+ <title><gui>Translate messages</gui></title>
+ <p>By default errors and warnings message are translated. It has two
+ drawbacks though. In order to recognize errors and warnings the
+ translation of <app>Anjuta</app> and the compiler should perfectly match.
+ Moreover, it is often more difficult to find help on internet when
+ searching translated messages as they are much less common. Unchecking
+ this check box allows to disable translation.</p>
+ </item>
+ <item>
+ <title><gui>Highlight build warnings and errors in editor</gui></title>
+ <p>Errors and warnings during the build are displayed and highlighted in
+ the message window. By checking this option, they are higlighted in the
+ editor too.</p>
+ </item>
+ <item>
+ <title><gui>Install as root</gui></title>
+ <p>Installing a program needs to copy files in system directory which are
+ often not writable by the user. If this check box is checked, you can choose
+ to use <cmd>sudo</cmd> or <cmd>su</cmd> before installing the files
+ to acquire enough right to do it.</p>
+ </item>
+ </terms>
+
+</page>
+
diff --git a/manuals/anjuta-manual/C/full-index.page b/manuals/anjuta-manual/C/full-index.page
index b666ba8..d310d7c 100644
--- a/manuals/anjuta-manual/C/full-index.page
+++ b/manuals/anjuta-manual/C/full-index.page
@@ -3,9 +3,9 @@
type="facets"
id="full-index">
<info>
- <link type="guide" xref="index#full-index"/>
+ <link type="guide" xref="index#reference"/>
<facet:match key="all-pages"/>
- <desc>Index of all Anjuta help topics.</desc>
+ <desc>All help topics.</desc>
<revision pkgversion="3.0" version="0.1" date="2011-05-01" status="incomplete"/>
<credit type="author">
<name>Philip Chimento</name>
@@ -13,5 +13,5 @@
</credit>
</info>
- <title>Index of all help topics</title>
+ <title>Index</title>
</page>
diff --git a/manuals/anjuta-manual/C/index.page b/manuals/anjuta-manual/C/index.page
index 94d7d25..3222ae3 100644
--- a/manuals/anjuta-manual/C/index.page
+++ b/manuals/anjuta-manual/C/index.page
@@ -28,8 +28,8 @@
<title>Project Management</title>
</section>
- <section id="anjuta-build" style="2column" groups="first second third">
- <title>Building and running</title>
+ <section id="anjuta-build" style="2column" groups="first second third fourth fifth sixth">
+ <title>Building Project</title>
</section>
<section id="anjuta-code" style="2column">
@@ -37,15 +37,15 @@
</section>
<section id="anjuta-debug" style="2column" groups="first second third">
- <title>Debugging</title>
+ <title>Running and Debugging</title>
</section>
<section id="anjuta-glade" style="2column" groups="first second">
<title>User interface editor</title>
</section>
- <section id="full-index">
- <title>Index</title>
+ <section id="reference">
+ <title>Reference</title>
</section>
</page>
diff --git a/manuals/anjuta-manual/C/widget-index.page b/manuals/anjuta-manual/C/widget-index.page
new file mode 100644
index 0000000..3514d7a
--- /dev/null
+++ b/manuals/anjuta-manual/C/widget-index.page
@@ -0,0 +1,17 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:facet="http://projectmallard.org/facet/1.0/";
+ type="facets"
+ id="widget-index">
+ <info>
+ <link type="guide" xref="index#reference"/>
+ <facet:match key="all-widgets"/>
+ <desc>All windows and dialogs.</desc>
+ <revision pkgversion="3.0" version="0.1" date="2011-05-01" status="incomplete"/>
+ <credit type="author">
+ <name>SÃbastien Granjoux</name>
+ <email>seb sfo free fr</email>
+ </credit>
+ </info>
+
+ <title>Windows and dialogs</title>
+</page>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
