From 73f53173ecee33b2b6df44216075a001ff9338ce Mon Sep 17 00:00:00 2001 From: Jeff Johnston Date: Thu, 26 Apr 2012 15:38:32 -0400 Subject: [PATCH] Rewrite Autotools docs to use CDT Autotools User Guide Wiki. Change-Id: I1001d49b52a5bb49a65f6d3d899ec5e59dded38c Reviewed-on: https://git.eclipse.org/r/5678 Reviewed-by: Jeff Johnston IP-Clean: Jeff Johnston Tested-by: Jeff Johnston --- .../Autotools/User_Guide/Building.html | 8 ++-- .../Autotools/User_Guide/Configuration.html | 22 ++++----- .../Creating-an-Autotools-Project.html | 12 ++--- .../User_Guide/Invoking-Autotools.html | 29 +++++++----- .../Autotools/User_Guide/Make-Targets.html | 8 ++-- .../Autotools/User_Guide/Special-Editors.html | 8 ++-- .../User_Guide/Supported-Environments.html | 4 +- .../User_Guide/Updating-This-Document.html | 2 +- .../Autotools/User_Guide/User-Guide.html | 5 +- .../User_Guide/images/AutotoolsAclocal.png | Bin 0 -> 29924 bytes .../images/AutotoolsAutoconfEditor.png | Bin 0 -> 133703 bytes .../User_Guide/images/AutotoolsAutoheader.png | Bin 0 -> 22554 bytes .../User_Guide/images/AutotoolsAutomake.png | Bin 0 -> 28836 bytes .../images/AutotoolsAutomakeEditor.png | Bin 0 -> 163323 bytes .../User_Guide/images/AutotoolsAutoreconf.png | Bin 0 -> 23040 bytes .../images/AutotoolsBuildConsole.png | Bin 0 -> 134297 bytes .../images/AutotoolsBuildMakeTarget.png | Bin 0 -> 34878 bytes .../User_Guide/images/AutotoolsBuilders.png | Bin 0 -> 59147 bytes .../images/AutotoolsCBuildProperties.png | Bin 0 -> 83679 bytes .../User_Guide/images/AutotoolsCheckOutAs.png | Bin 0 -> 69935 bytes .../images/AutotoolsConfigureConsole.png | Bin 0 -> 144912 bytes .../images/AutotoolsConfigureSettings.png | Bin 0 -> 82645 bytes .../User_Guide/images/AutotoolsConsole.png | Bin 0 -> 135340 bytes .../images/AutotoolsConvertProject.png | Bin 0 -> 46241 bytes .../images/AutotoolsConvertToCProject.png | Bin 0 -> 79984 bytes .../images/AutotoolsConvertWizard.png | Bin 0 -> 43530 bytes .../images/AutotoolsCreateMakeTarget.png | Bin 0 -> 36716 bytes .../images/AutotoolsEditorPreferences.png | Bin 0 -> 61837 bytes .../User_Guide/images/AutotoolsEditorsTab.png | Bin 0 -> 57754 bytes .../User_Guide/images/AutotoolsLibtoolize.png | Bin 0 -> 21510 bytes .../images/AutotoolsMakeTargetMenu.png | Bin 0 -> 150895 bytes .../images/AutotoolsManageConfigurations.png | Bin 0 -> 23016 bytes .../images/AutotoolsModifyMakeTarget.png | Bin 0 -> 34130 bytes .../images/AutotoolsNewCProjectWizard.png | Bin 0 -> 61696 bytes .../images/AutotoolsNewConfiguration.png | Bin 0 -> 70189 bytes .../User_Guide/images/AutotoolsProperties.png | Bin 0 -> 51618 bytes .../images/AutotoolsToolSettings.png | Bin 0 -> 53624 bytes .../org.eclipse.cdt.autotools.docs/ChangeLog | 44 ++++++++++++++++++ .../Linuxtool-AutotoolsMakeTargetsMenu.png | Bin 102235 -> 0 bytes .../images/Linuxtools-AutotoolsAclocal.png | Bin 23927 -> 0 bytes .../Linuxtools-AutotoolsAutoconfEditor.png | Bin 138864 -> 0 bytes ...inuxtools-AutotoolsAutoconfEditorPrefs.png | Bin 44442 -> 0 bytes .../images/Linuxtools-AutotoolsAutoheader.png | Bin 19658 -> 0 bytes .../images/Linuxtools-AutotoolsAutomake.png | Bin 28010 -> 0 bytes .../Linuxtools-AutotoolsAutomakeEditor.png | Bin 117419 -> 0 bytes .../images/Linuxtools-AutotoolsAutoreconf.png | Bin 19100 -> 0 bytes .../images/Linuxtools-AutotoolsAutotools.png | Bin 57177 -> 0 bytes .../Linuxtools-AutotoolsAutotoolsConsole.png | Bin 83321 -> 0 bytes .../Linuxtools-AutotoolsBuildLocation.png | Bin 92584 -> 0 bytes .../images/Linuxtools-AutotoolsBuilders.png | Bin 55700 -> 0 bytes .../Linuxtools-AutotoolsCProjectWizard.png | Bin 63270 -> 0 bytes .../images/Linuxtools-AutotoolsCheckout.png | Bin 67446 -> 0 bytes .../Linuxtools-AutotoolsConfsettings.png | Bin 42694 -> 0 bytes .../Linuxtools-AutotoolsConsolePrefs.png | Bin 68815 -> 0 bytes .../Linuxtools-AutotoolsConsoleSelect.png | Bin 102597 -> 0 bytes ...inuxtools-AutotoolsConvAutotoolsWizard.png | Bin 60383 -> 0 bytes .../Linuxtools-AutotoolsConvertWizard.png | Bin 69004 -> 0 bytes .../images/Linuxtools-AutotoolsCreateConf.png | Bin 53458 -> 0 bytes .../images/Linuxtools-AutotoolsEditorsTab.png | Bin 52209 -> 0 bytes .../images/Linuxtools-AutotoolsLibtoolize.png | Bin 19291 -> 0 bytes .../Linuxtools-AutotoolsMakeTargetBuild.png | Bin 36302 -> 0 bytes .../Linuxtools-AutotoolsMakeTargetCreate.png | Bin 38730 -> 0 bytes .../Linuxtools-AutotoolsMakeTargetEdit.png | Bin 39725 -> 0 bytes .../Linuxtools-AutotoolsManageConfs.png | Bin 23339 -> 0 bytes .../images/Linuxtools-AutotoolsNewOther.png | Bin 42608 -> 0 bytes .../Linuxtools-AutotoolsToolSettings.png | Bin 54115 -> 0 bytes .../build-helper.xml | 15 +++--- .../build.properties | 4 +- build/org.eclipse.cdt.autotools.docs/toc.xml | 22 ++++----- 69 files changed, 117 insertions(+), 66 deletions(-) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/Building.html (97%) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/Configuration.html (80%) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/Creating-an-Autotools-Project.html (82%) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/Invoking-Autotools.html (82%) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/Make-Targets.html (95%) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/Special-Editors.html (94%) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/Supported-Environments.html (79%) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/Updating-This-Document.html (93%) rename build/org.eclipse.cdt.autotools.docs/{Linux_Tools_Project => CDT}/Autotools/User_Guide/User-Guide.html (93%) create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsAclocal.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsAutoconfEditor.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsAutoheader.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsAutomake.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsAutomakeEditor.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsAutoreconf.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsBuildConsole.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsBuildMakeTarget.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsBuilders.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsCBuildProperties.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsCheckOutAs.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsConfigureConsole.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsConfigureSettings.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsConsole.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsConvertProject.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsConvertToCProject.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsConvertWizard.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsCreateMakeTarget.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsEditorPreferences.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsEditorsTab.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsLibtoolize.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsMakeTargetMenu.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsManageConfigurations.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsModifyMakeTarget.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsNewCProjectWizard.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsNewConfiguration.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsProperties.png create mode 100644 build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/images/AutotoolsToolSettings.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtool-AutotoolsMakeTargetsMenu.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAclocal.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAutoconfEditor.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAutoconfEditorPrefs.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAutoheader.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAutomake.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAutomakeEditor.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAutoreconf.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAutotools.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsAutotoolsConsole.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsBuildLocation.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsBuilders.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsCProjectWizard.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsCheckout.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsConfsettings.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsConsolePrefs.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsConsoleSelect.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsConvAutotoolsWizard.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsConvertWizard.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsCreateConf.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsEditorsTab.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsLibtoolize.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsMakeTargetBuild.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsMakeTargetCreate.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsMakeTargetEdit.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsManageConfs.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsNewOther.png delete mode 100644 build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/images/Linuxtools-AutotoolsToolSettings.png diff --git a/build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Building.html b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Building.html similarity index 97% rename from build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Building.html rename to build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Building.html index 256bff75bb1..868620addcd 100644 --- a/build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Building.html +++ b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Building.html @@ -38,7 +38,7 @@ Build (GNU) which configures and builds in the top-level project directory. This is common for Autotools projects to have the user configure and build directly in the top-level source directory. The location of the build can be changed in the C/C++ Build properties:

- +

Notice how the default is ${workspace_loc:/xxxx} where xxxx is the project name. This represents the project's location which may or may not be physically under the workspace root directory. To change the build location, it is recommended that you add a directory following the project location: e.g. ${workspace_loc:/xxxx}/yyyy.

It should be noted that the configure script automatically checks to see if a configuration has been performed in the source directory. It does so by looking for the @@ -51,7 +51,7 @@

CDT build configurations are managed via the Managed Configurations dialog. The dialog is accessed via a button that can be found on any property page that alters data that is part of the build configuration. This includes the Project -> Properties -> Autotools -> Configure Settings page. Pressing the button results in the Manage Configurations dialog:

- +

From the dialog, it is possible to create a new configuration, rename a configuration, delete a configuration, or set a particular configuration as being the active one. Deletion is disabled when there is only one configuration. Likewise, if there is only one configuration, it is active by default. When you choose to create a new configuration (hit the New... button), you are given a number of choices. You can:

    @@ -77,11 +77,11 @@

- +

Copying a configuration copies all of its settings, including the Autotools configuration parameters. Copying all settings would normally include the build location (the directory where the build will be performed), but the Autotools plug-in, by default, intercedes and for every new configuration subsequent to the initial one, it sets the build location to build-xxxx where xxxx is the unique configuration name. The Autotools plug-in replaces any white-space in the configuration name with underscores so it is possible if you have named two configurations similarly with different white-space characters or one with underscores that you might result in a build location collision. The replacement of white-space is done because the build directory will get placed in the generated Makefile where white-space is used as delimiters and undefined behaviour would therefore occur. The automatic build directory naming behaviour can be turned off from the Project -> Properties -> Autotools page, but it is discouraged since switching between different configurations and building in the same directory can cause undefined behaviour.

- +

Note: changes to configurations are not performed unless the Ok or Apply buttons are pressed from a Property page with the Manage Configurations button on it. That is, pressing Ok from the Manage Configurations dialog does not make the changes permanent. You could add new configurations, delete others, and then hit the Cancel button from the corresponding property page and the changes would be reverted.

diff --git a/build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Configuration.html b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Configuration.html similarity index 80% rename from build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Configuration.html rename to build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Configuration.html index 2df1516ed37..188c262921a 100644 --- a/build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Configuration.html +++ b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Configuration.html @@ -33,10 +33,10 @@

Prior to running a build, the Autotools plug-in runs the configure script. Parameters to be passed to configure may be entered via the Project -> Properties -> Autotools -> Configure Settings UI shown below:

- +

-

You will notice how the actual configure script name is editable. It is not recommended you change the name of the configure script as this is standard for Autotool projects. However, one use of this text input is to add environment variables to set prior to invoking the configure script. For example, you might want to set the command to: - CFLAGS="-g -debug" configure to have the CFLAGS environment variable overridden while configuring. The same applies to the autogen.sh script settings. +

If the top-level tree item: "Configure" is selected, you will notice how the actual configure script name is editable. It is not recommended you change the name of the configure script as this is standard for Autotool projects. However, you can use this text input to add environment variables to set prior to invoking the configure script. For example, you might set the command to: + CFLAGS="-g -debug" configure to have the CFLAGS environment variable overridden while configuring. The same applies to the autogen.sh script settings. On the advanced options page, there are a few prepared compilation options such as: compiling for debugging, compiling for the gcov tool, and compiling for the gprof tool. One can also specify these options directly in the additional command-line options field as demonstrated in the screen-shot above.

For configure, there are a number of standard parameters that apply to generated configure scripts. Each parameter has its command line name presented so you can look it up in Autotools documentation. In addition, tool-tip hover help is provided.

Under the Advanced category, there is a free-form line called "Additional command-line options" where you may enter any options in their command-line format. This is useful for entering custom options that your configure script supports (e.g. --enable-feature-x or --with-lib-y). It can also be used for any of the standard parameters as well if that is more familiar tor you. Parameters in this list are appended to the end of parameters derived from the standard option entries (i.e. you could get two specifications of a parameter). In the case of multiple specification, behaviour is the same as it is on the command line. You can optionally check off the "Display help contents (--help)" option under the General category to see all the standard and custom options the configure script accepts. As the configure script help is a product of how it is written, it is sometimes possible that the help is out of date with regards to added features.

@@ -80,22 +80,22 @@

If after all of this, the top-level Makefile is not created, an error is generated and building stops.

-

The configure process can be manually forced for a project via the Project -> Reconfigure Project menu item. A reconfigure runs the configure script even if a config.status file is found indicating a prior configuration was successful.

-

The entire configuration step is performed by a special builder that is added when an Autotools project is created or converted from another project. The special builder runs the configure step and is positioned to run prior to the Makefile builder.

+

The configure process can be manually forced for a project via right-clicking on any file in the project to get the Context menu and selecting the Reconfigure Project menu item. A reconfigure runs the configure script even if a config.status file is found indicating a prior configuration was successful.

+

The entire configuration step is performed by a special builder that is added when an Autotools project is created or converted from another project. The special builder runs the configure step and is positioned in the builder order to run prior to the Makefile builder.

From the Project -> Properties -> Builders tab for a project you will see:

- +

Do not un-check the Autotools Makefile builder nor change the order of the builders. Modifying this will result in undefined behaviour.

-

The configure step is run in a special Configuration console added by the Autotools plug-in. This console is separate from the C-Build console which is used to display the results of the make command invocation.

-

To see the Configure console, click on the console selector button (icon looks like a T.V.) found in the Console View as follows:

+

The configure step output goes to a special Configuration console added by the Autotools plug-in. This console is separate from the C-Build console which is used to display the results of the make command invocation.

+

To see the Configure console, click on the console selector button (icon looks like a T.V.) found in the Console View and choose an entry which starts with "Configure" and has the project name.

- +

-

Note that the configure console output is per project and shows configuration output for the last build of the project. It is not saved between Eclipse sessions.

+

Note that configure console output is per project and shows configuration output for the last build of the project. It is not saved between Eclipse sessions.

The Autotools console is an instance of a CDT Build console so the console preferences set in Window -> Preferences -> C/C++ -> Build Console apply as well.

- +

diff --git a/build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Creating-an-Autotools-Project.html b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Creating-an-Autotools-Project.html similarity index 82% rename from build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Creating-an-Autotools-Project.html rename to build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Creating-an-Autotools-Project.html index 28232652ee6..c69673e0e78 100644 --- a/build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Creating-an-Autotools-Project.html +++ b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Creating-an-Autotools-Project.html @@ -33,29 +33,29 @@

There a number of ways to create an Autotools project. The first method is through the CDT C and C++ Project wizards which can be activated from the File -> New -> C Project and File -> New -> C++ Project menu items, respectively, which are available while in the C/C++ Perspective. These two wizards can also be located by clicking on the File -> New -> Project... menu item and then opening the C/C++ folder found there.

Looking at the C Wizard, we see that there is a GNU Autotools category.

- +

-

Opening the category, there are two choices: Empty Project or Hello World Ansi C Autotools Project. The Empty Project template means that no files will be supplied to the new project while the Hello World project will supply a sample hello world program that uses Autotools for configuring the build. The C++ Project Wizard also has the same GNU Autotools category and two project templates: an Empty Project and a Hello World C++ Autotools sample program. If you are creating a project from scratch, it is recommended that you use the Hello World sample project and make modifications. Otherwise, you will need to create a configure script for the Autotools plug-in to invoke at build time or provide a Makefile so the configuration step does not fail.

+

Opening the category, there are three choices: Empty Project, Autotools Shared Library Project, or Hello World Ansi C Autotools Project. The Empty Project template means that no files will be supplied to the new project while the Hello World project will supply a sample hello world program that uses Autotools for configuring the build. The Autotools Shared Library project is an example of how to use Autotools to create a shared library. The C++ Project Wizard also has the same GNU Autotools category and the three project templates: an Empty Project, Autotools Shared Library, and a Hello World C++ Autotools sample program. If you are creating a project from scratch, it is recommended that you use either the Hello World sample project or the Autotools Shared Library sample project and make modifications. Otherwise, you will need to create a configure script for the Autotools plug-in to invoke at build time or provide a Makefile so the configuration step does not fail.

The C and C++ Wizards can also be used when importing an existing Autotools project. For example, when importing a project from CVS using File -> Import... -> CVS -> you are given the choice to "Check out as a project configured by the new project wizard".

- +

From the New Project menu, open the C/C++ category and choose either a C Project or C++ Project, depending on the type of project being imported. If the code is both C and C++, choose C++ Project.

Let's say you have a C application using Autotools and select C Project. This will bring up the C Project Wizard as displayed earlier. In this case, choose the Empty Project from the GNU Autotools category as you already have all the configuration files in place.

Another method to create an Autotools project is to convert an existing project. For example, if we import a project from SVN or CVS and do not configure using the new project wizard, the project will simply be downloaded into the workspace. At this point, it cannot be built or access various tools from the CDT.

To convert it, select the project in the Project Explorer and open the File -> New -> Convert to C/C++ Project menu item as found in the C/C++ Perspective. If in another perspective, this same wizard can be found by selecting File -> New -> Other... -> C/C++ -> Convert to a C/C++ Project. This brings up the C/C++ Conversion wizard.

- +

Note how there is a set of projects that are candidates for conversion. This list contains any projects that are not already C or C++ projects. A C or C++ project includes regular CDT Managed Make and Makefile projects. Also note that the project you selected is automatically selected when the wizard opens.

There is a choice of C or C++ project and a set of project types to choose from. For Autotools, select the GNU Autotools category and this will convert to an Autotools project. Once converted, this project will not show up as a candidate project in the conversion wizard.

The final way to create an Autotools project is to use the Autotools Conversion wizard. This wizard allows one to convert from any form of project to an Autotools project. Obviously, converting a project that isn't actually C or C++ and using Autotools will result in undefined behaviour. You need to first select the project you wish to convert. After selecting, go to File -> New -> Other... -> C/C++, open the category, select "Convert to a C/C++ Autotools Project" and hit the Next button.

- +

This brings up the following dialog:

- +

Again, there are candidates for conversion. This list contains all projects that are not currently C or C++ Autotool projects. You are given the choice of C or C++ as with the standard C/C++ conversion wizard. Hitting the Finish button is all that is needed, but if you hit the Next button and continue on you can select referenced projects, if desired.

Once converted to an Autotools project, there is no UI method to convert back to a regular C/C++ project. If this is desired, you need to manually remove the .project, .cproject, and .autotools files from the project directory. This will effectively remove the natures and CDT settings for the project, allowing you to convert it again however you want.

diff --git a/build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Invoking-Autotools.html b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Invoking-Autotools.html similarity index 82% rename from build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Invoking-Autotools.html rename to build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Invoking-Autotools.html index 78308c2216b..5f2868ef800 100644 --- a/build/org.eclipse.cdt.autotools.docs/Linux_Tools_Project/Autotools/User_Guide/Invoking-Autotools.html +++ b/build/org.eclipse.cdt.autotools.docs/CDT/Autotools/User_Guide/Invoking-Autotools.html @@ -30,9 +30,9 @@

Invoking Autotools

-

To invoke the Autotools, a special menu item has been added to the Project menu. Under Project -> Invoke Autotools there are a set of menu items to invoke the various Autotools for your project. The output of the tool invocation is presented in a special Autotools Console. Like the Configure and C-Build Consoles, the Autotools console is per-project and is not saved across Eclipse sessions. The console, if present, can be accessed via the "Display Selected Console" button in the Console View.

+

To invoke the Autotools, a special sub-menu has been added to the project Context menu. Select any file in the project and then click on Invoke Autotools. There you will find a set of menu items to invoke the various Autotools for your project. The output of the tool invocation is presented in a special Autotools Console. Like the Configure and C-Build Consoles, the Autotools console is per-project and is not saved across Eclipse sessions. The console, if present, can be accessed via the "Display Selected Console" button in the Console View.

- +

The tools provided are:

    @@ -46,7 +46,8 @@
  1. Invoke Automake