docs.kde.org
Automake Manager Operation
Prev
Next

Automake Manager Operation

In this chapter you will find a basic description of the Automake Manager elements and how to use them. This covers:

The Automake Manager Window

  • Automake Manager runs in a split window. The top part is called the Overall View and the bottom part is called the Detail View. Between them is a narrow bar that can be dragged with the mouse to adjust the sizes of the views. In IDEAl mode you can also drag the side of the split window to change the width.

  • On top of each view there is a toolbar, the buttons in which will become activated when an element in this view is selected. This provides one way you can access the actions provided for that view element. The other are context menus which pop up on right mouse button click as will be discussed below.

  • In IDEAl mode there are two additional small buttons in the Automake Manager window titlebar left hand side – a triangular shaped right arrow, and a dot button. The arrow button is used to close the window. The dot button on the other hand will keep the window open even if another KDevelop window has been selected. (Otherwise the Automake Manager window will automatically close whenever another window gets the input focus.)

The Overall View Window

The overall view window contains a tree-list of all the directories in your project that contain program files, documentation or data. Each such directory contains a Makefile.am file and is known in Automake Manager as a subproject. There are three typical subprojects in a KDE-based project as shown in the above illustration:

  • src – source-code files for your application,

  • doc – your user manual or Handbook,

  • po – extracts of strings in your source-code files that require translation into other human languages (e.g. window titles, menu names, button labels, dialog box text and messages of various kinds).

Note that the doc subproject always has an en subproject, which you can see if you click on the + symbol next to the word doc. That is because the base language of all documentation in KDE is United States English (en). If your application becomes part of KDE, the KDE translation teams may translate your documentation from United States English into other languages and the translations will go into other subprojects, such as de (German) or fr (French). The strings in the po subproject may also be translated and stored in other files in po, thus allowing your application to be operated by people who do not know English.

Note

The doc and po subprojects serve different purposes. doc contains documentation like a user manual, po contains translatable text strings of the user interface which is integrated in the source code of this application.

The overall view window serves—amongst other things—as a navigation tool. If you select a subproject in the overall view window, the corresponding details will be shown in the detail view window.

The Detail View Window

The detail view contains a tree-list of all the files in the subproject currently selected in the overall view as well as the compilation, build and installation rules for this subproject. Thus the two views together can give you access to all the components of your application and all the information on how to compile, build and install it.

Targets

The tree-list in the detail view has two levels. The top level consists of so-called Automake Manager targets and the next level contains lists of files that go to make up each target.

This concept of an Automake Manager target differs somewhat from what a Makefile target usually is. In short:

  • The definition of how a set of files is to be compiled, built or installed is known as a target in Automake Manager, but as a variable in Automake itself.

  • A target in make is often something quite different, being the parameter of a make command (e.g. make install, make clean).

    However some Makefile.am variables do represent an underlying sub-target in make.

Navigating in the Automake Manager

In both the overall and the detail view you can left-click on the + or - next to a subproject or target name to expand or contract the tree view. If you do that with a subproject in the overall view, it shows or hides the subprojects at the next level down (if any). If you do it with a target in the detail view, it shows or hides the list of files that go into that target.

Opening a file for Edit

If you left mouse button click on a file name in the detail view, the corresponding file opens up in KDevelop's editing window.

Activating the Automake Manager Toolbar Buttons

If you left mouse button click on the name of a subproject in the overall view or target in the detail view, the name is highlighted and some toolbar buttons become active in the top part of that view.

Note

It is recommended that you use the right mouse-button and popup menus, rather than the toolbar buttons, because it is then much easier to see and understand what you are doing.

Operations on subprojects and targets have far-reaching effects on the structure, compilation, building and installation of your application.

Selecting Actions/Popup Menus

If you right mouse button click on the name of a subproject, target or file, a menu pops up and you can then select actions to perform on the subproject, target or file, such as add a target to the subproject, add a file to a target or logically remove the selected file from its target.

Popup Menus in the Automake Manager

The following sections explain in short terms which operations the menus make available which will pop up on right mouse button clicks in the Automake Manager window. They are meant for overall view only. You will find detailed descriptions of most operations in a later chapter.

The Popup Menu for a File

When you right mouse button click on a file name in the detail view the following menu will pop up allowing you to select one of several operations to be performed on that file. In the illustration below the hi-16app-myapp.png icon file was selected from the Icon data in myapp target of the myapp/src subproject.

  • The main popup-menu item for a file is to Remove the file from its target (i.e. it will no longer be used to compile, build or install that target).

  • The CVS item offers a variety of CVS operations on the file.

  • The Open With item allows you to open the file with a variety of editors or with any application at all (e.g. you can open the icon file in our example with K3Icon).

  • The Perforce item is used for similar operations as in CVS using the commercial “Perforce” version control system.

The Popup Menu for a Target

When you right-click on a target in the detail view the following menu will pop up allowing you to select one of several operations to be performed on it. In the illustration below the myapp (Program in bin) target of the myapp/src subproject was selected.

  • The Options item for a target only applies to source code files. In the corresponding dialog box you can specify linker flags and paths on which to locate libraries and you can give a list of actual libraries to be linked in to your application.

  • The Create New File item brings up a dialog in which you can set the file name and the type of file to be generated (from a drop-down list).

  • The Add Existing Files item brings up a dialog box in which you can add an already existing file to this target.

  • The Remove item for a target allows you to logically remove the target and all its files from the project structure.

  • The Make Target Active item only applies to targets containing source code files. New files will always be added to such an active target.

  • The Build Target item calls all necessary compile and make operations to build the code for this target only.

The Popup Menu for a Subproject

When you right mouse button click on a subproject in the overall view window the following menu will pop up which allows you to make major changes to the structure of your project and the way it is compiled, built and installed. You can use it to expand or modify the basic project structure that the Application Wizard has created.

  • The Options item for a subproject controls the way that the subproject will be compiled, built and installed. The dialog box that pops up has tabs for Compiler, Includes, Prefixes and Build Order.

  • The Add Subproject item creates a new directory and skeleton Makefile.am file.

  • The Add Target item pops up a dialog in which you can set the rules for compiling, building or installing a group of files within your subproject.

  • Add Service (... to be written ...)

  • Add Application (... to be written ...)

  • Add Existing Subprojects (... to be written ...)

  • The Remove Subproject item in the popup menu for a subproject is the proper way to remove a subproject. It will adjust the Makefile.am files accordingly. You will also be offered the option to delete all the files (or links) in the corresponding subdirectory. Obviously, this feature should be used with caution.

  • The Build item calls all necessary compile and make operations to build the code for this subproject only.

  • Force Reedit (... to be written ...)

  • Clean (... to be written ...)

  • Install (... to be written ...)

  • Install (as root user) (... to be written ...)

Prev
Next
Home


docs.kde.org