diff options
Diffstat (limited to 'doc/en/projects.docbook')
| -rw-r--r-- | doc/en/projects.docbook | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/en/projects.docbook b/doc/en/projects.docbook index c39e3aa..f5d2964 100644 --- a/doc/en/projects.docbook +++ b/doc/en/projects.docbook @@ -2,10 +2,10 @@ <title>Working with Projects</title> <para> -Before any significant work can be done with &kapp;, the user needs to define a project. A &kapp; project is a set of source files, which <application>Cscope</application> uses to create its cross-reference database. Unlike many other project-based environments, &kapp; is not intrusive: it only uses three files to define the project (with additional two files if the inverted index option is used). These files reside on a user-specified folder that does not have to be related to the location of the source files. Thus, &kapp; does not require any source files to be moved, and does not affect the structure of the source tree. +Before any significant work can be done with &tdeApp;, the user needs to define a project. A &tdeApp; project is a set of source files, which <application>Cscope</application> uses to create its cross-reference database. Unlike many other project-based environments, &tdeApp; is not intrusive: it only uses three files to define the project (with additional two files if the inverted index option is used). These files reside on a user-specified folder that does not have to be related to the location of the source files. Thus, &tdeApp; does not require any source files to be moved, and does not affect the structure of the source tree. </para> <para> -The files used by a &kapp; project are: +The files used by a &tdeApp; project are: <variablelist> <varlistentry> <term><filename>cscope.proj</filename></term> @@ -31,7 +31,7 @@ The files used by a &kapp; project are: </para> <para> -The only limitation imposed by &kapp; is that these files have to reside in the same directory, referred to as the project's directory. The project's directory has the same name as the project (which means that project names should conform to the file-system conventions), and can be placed by the user under any directory. Normally, a user will create a <filename>projects</filename> sub-directory under his or her home directory, and create all projects there. However, this is only a convention, and, as explained above, the user can choose any other method he or she prefers. Furthermore, the project's directory can later be moved to another parent directory, without any risk of data loss. +The only limitation imposed by &tdeApp; is that these files have to reside in the same directory, referred to as the project's directory. The project's directory has the same name as the project (which means that project names should conform to the file-system conventions), and can be placed by the user under any directory. Normally, a user will create a <filename>projects</filename> sub-directory under his or her home directory, and create all projects there. However, this is only a convention, and, as explained above, the user can choose any other method he or she prefers. Furthermore, the project's directory can later be moved to another parent directory, without any risk of data loss. </para> <sect2 id="project-create"> @@ -66,11 +66,11 @@ Note that this dialogue is intended for creating an empty project only, and has </varlistentry> <varlistentry> <term><guilabel>Path</guilabel></term> -<listitem><para>The full path of the directory under which the new project will be created. &kapp; will create a new directory under this one, and name it after the project. Thus this path does not need to point directly to the project's directory, but rather to the project's parent directory. For example, if a user wants to create a project called "my_project" under his local <filename>projects</filename> directory, the project's name should be set to "my_project" and the path to <filename>/home/my_username/projects</filename>. This will set the project's directory to <filename>/home/my_username/projects/my_project</filename>.</para></listitem> +<listitem><para>The full path of the directory under which the new project will be created. &tdeApp; will create a new directory under this one, and name it after the project. Thus this path does not need to point directly to the project's directory, but rather to the project's parent directory. For example, if a user wants to create a project called "my_project" under his local <filename>projects</filename> directory, the project's name should be set to "my_project" and the path to <filename>/home/my_username/projects</filename>. This will set the project's directory to <filename>/home/my_username/projects/my_project</filename>.</para></listitem> </varlistentry> <varlistentry> <term><guilabel>Source Root (Optional)</guilabel></term> -<listitem><para>The top-level directory that contains the source files to be included in the project. This path only serves as a hint to &kapp;, as files may later be added from different directories as well By default, this value is set to the root directory.</para></listitem> +<listitem><para>The top-level directory that contains the source files to be included in the project. This path only serves as a hint to &tdeApp;, as files may later be added from different directories as well By default, this value is set to the root directory.</para></listitem> </varlistentry> </variablelist> </sect3> @@ -144,7 +144,7 @@ Note that this dialogue is intended for creating an empty project only, and has </varlistentry> <varlistentry> <term><guilabel>Refresh database automatically</guilabel></term> -<listitem><para>&kapp; can rebuild the cross-reference database automatically, a process which is triggered when a source file is saved. If this option is selected, the user needs to specify the time (in seconds) that should elapse after each file save operation and before the database is rebuilt.</para></listitem> +<listitem><para>&tdeApp; can rebuild the cross-reference database automatically, a process which is triggered when a source file is saved. If this option is selected, the user needs to specify the time (in seconds) that should elapse after each file save operation and before the database is rebuilt.</para></listitem> </varlistentry> <varlistentry> <term><guilabel>Use symbol auto-completion</guilabel></term> @@ -260,7 +260,7 @@ The project's list of source files is maintained by the <guilabel>Project Files< <para> -Once the list of project files changes (either when files are first added to the project, or upon any subsequent modification), &kapp; informs <application>Cscope</application> to rebuild the cross-reference database. +Once the list of project files changes (either when files are first added to the project, or upon any subsequent modification), &tdeApp; informs <application>Cscope</application> to rebuild the cross-reference database. </para> </sect2> @@ -312,7 +312,7 @@ When a project is closed, it saves session information, such as source files bei </para> <para> -After the project has been opened, &kapp; will invoke <application>Cscope</application>, which, in turn, will check whether any files have been modified since the last time the project had been closed. If any files have changed, <application>Cscope</application> will rebuild the cross-reference database. +After the project has been opened, &tdeApp; will invoke <application>Cscope</application>, which, in turn, will check whether any files have been modified since the last time the project had been closed. If any files have changed, <application>Cscope</application> will rebuild the cross-reference database. </para> </sect2> @@ -338,11 +338,11 @@ Temporary projects are created when a user opens a cscope.out file directly. Thi </para> <para> -To open a database file, use the <menuchoice><guimenu>Project</guimenu><guimenuitem>Open Cscope.out...</guimenuitem></menuchoice> menu command. If the file is a valid <application>Cscope</application> cross-reference database, &kapp; will invoke <application>Cscope</application> using this file, and will be ready to accept queries on the database. Cscope.out files can also be opened through the command line, which means that you can simply drag a Cscope.out file, and drop it over &kapp;'s programme icon. +To open a database file, use the <menuchoice><guimenu>Project</guimenu><guimenuitem>Open Cscope.out...</guimenuitem></menuchoice> menu command. If the file is a valid <application>Cscope</application> cross-reference database, &tdeApp; will invoke <application>Cscope</application> using this file, and will be ready to accept queries on the database. Cscope.out files can also be opened through the command line, which means that you can simply drag a Cscope.out file, and drop it over &tdeApp;'s programme icon. </para> <para> -Note, however, that most project management options provided by &kapp; will not be available for temporary projects: the file list for the project will be empty, users will not be able to add or remove files, and the project properties dialogue will not be available. You will also need to rebuild the database manually when making any changes. &kapp;'s rebuild command assumes the database has been updated, and only re-runs <application>Cscope</application>. +Note, however, that most project management options provided by &tdeApp; will not be available for temporary projects: the file list for the project will be empty, users will not be able to add or remove files, and the project properties dialogue will not be available. You will also need to rebuild the database manually when making any changes. &tdeApp;'s rebuild command assumes the database has been updated, and only re-runs <application>Cscope</application>. </para> </sect2> @@ -351,7 +351,7 @@ Note, however, that most project management options provided by &kapp; will not <title>Building Projects</title> <para> -While &kapp; was not designed as an IDE with a complete write-build-debug cycle, it does provide a simple GUI for building projects. The command <menuchoice><guimenu>Project</guimenu><guimenuitem>Make Project</guimenuitem></menuchoice> displays a dialogue, which can be used to invoke any external tool on a given directory. By default, it runs <command>make</command> on the project's source root. The output of the command will be displayed in the dialogue's <guilabel>Output</guilabel> pane, with any errors or warnings marked-up, similar to links in a browser. Clicking on a link will jump to an editor page showing the source file and line responsible for the message. A list of all abnormal messages also appears in the dialogue's <guilabel>Errors and Warnings</guilabel> pane. +While &tdeApp; was not designed as an IDE with a complete write-build-debug cycle, it does provide a simple GUI for building projects. The command <menuchoice><guimenu>Project</guimenu><guimenuitem>Make Project</guimenuitem></menuchoice> displays a dialogue, which can be used to invoke any external tool on a given directory. By default, it runs <command>make</command> on the project's source root. The output of the command will be displayed in the dialogue's <guilabel>Output</guilabel> pane, with any errors or warnings marked-up, similar to links in a browser. Clicking on a link will jump to an editor page showing the source file and line responsible for the message. A list of all abnormal messages also appears in the dialogue's <guilabel>Errors and Warnings</guilabel> pane. </para> <screenshot> |