Bug 193376 - Patch for Angelina - doc updates.

author: Doug Schaefer 2007-06-21 19:51:44 +0000
committer: Doug Schaefer 2007-06-21 19:51:44 +0000
commit: e27fb609c84f0ef38dd09e90fb24af69be0f3ed5 (patch)
tree: 23460c10f996dcdda51094bbb3ca8ef0dea651c7 /doc
parent: ecc0241a09ba99a55e2c97d244b5fd5d7c9267ff (diff)
download: org.eclipse.cdt-e27fb609c84f0ef38dd09e90fb24af69be0f3ed5.tar.gz
org.eclipse.cdt-e27fb609c84f0ef38dd09e90fb24af69be0f3ed5.tar.xz
org.eclipse.cdt-e27fb609c84f0ef38dd09e90fb24af69be0f3ed5.zip
4 files changed, 54 insertions, 59 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_before_you_begin.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_before_you_begin.htm
index 83b080e984c..58b9ef26a43 100644
--- a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_before_you_begin.htm
+++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_before_you_begin.htm
@@ -9,68 +9,71 @@
 <body>
 <h2>Before you begin</h2>
 
-<p>Depending on how you received the CDT you may or may not have also received
+<p>Depending on how you obtained the CDT, you might have also received
 a tool chain with a built-in CDT integration.
-If you simply downloaded the CDT from an update site, then one will be required before
-you can build and debug projects.</p>
+However, if you downloaded the CDT from an update site, then you will require a tool chain before
+you can build and debug any projects.</p>
 
 <p>The base CDT supports integration with the GNU tool chain.
 This includes GNU's make, gcc compiler, and gdb debugger utilities.
 If you require a tool chain to build software for your development host, this
 is the best choice to get started.
-Each platform that runs the CDT requires different steps to acquire this tool chain.</p>
+
+<p>Each platform that runs the CDT requires different steps to acquire this tool chain.</p>
 
 <h3>Linux</h3>
 <p>All Linux distributions include the GNU tool chain. They may not, however, be installed by default.
-Please see the instructions for your particular distribution on how to install it</p>
+For instructions about installing the GNU tool chain for Linux, see the instructions for your particular distribution.</p>
 
 <h3>Windows</h3>
-<p>There are two main choices for acquiring the GNU tool chain for Windows: MinGW, and Cygwin.</p>
-
-<p><a href="http://www.cygwin.com">Cygwin</a> is a port of the Linux environment to Windows.
+<p>For windows, MinGW, and Cygwin are the two main choices for acquiring the GNU tool chain:</p>
+<ul>
+<li><a href="http://www.cygwin.com"><b>Cygwin</b></a> is a port of the Linux environment to Windows.
 It provides a compatibility layer in a set of DLLs. These DLLs are
-<a href="http://www.gnu.org/copyleft/gpl.html">GPL licensed</a>
+<a href="http://www.gnu.org/copyleft/gpl.html">GPL licensed</a>,
 making any code that links to them also subject to the GPL.
 Cygwin, however, does provide the fullest implementation of the GNU tool chain
-by supporting the GNU libc C library.</p>
-
-<p><a href="http://www.mingw.org">MinGW</a> is a port of the GNU tool chain to the Windows platform.
+by supporting the GNU libc C library.
+<p> <br></p>
+</li>
+<li><a href="http://www.mingw.org"><b>MinGW</b></a> is a port of the GNU tool chain to the Windows platform.
 The biggest difference over Cygwin is that MinGW uses the Windows C libraries (mscvrt) instead
-of GNU's libc. As a result a compatibility layer is not required, thus avoiding the GPL issues
+of GNU's libc. As a result, a compatibility layer is not required, thus avoiding the GPL issues
 with Cygwin. However, there are differences between the Windows and GNU C libraries that will make
-writing portable applications more difficult.</p>
-
+writing portable applications more difficult.
+<br>
 <p>MinGW allows the best integration support with the CDT
-due to it's direct support for the Windows environment.
-The following are instructions and links on how to install the current version
-of MinGW. Note that these links may become stale over time as new versions of
+due to it's direct support for the Windows environment.</p>
+<br>
+<p>The following are instructions and links on how to install the current version
+of MinGW. Note that these links may become inaccurate over time as new versions of
 MinGW components are introduced. Please check the
 <a href="http://sourceforge.net/project/showfiles.php?group_id=2435">
 MinGW File Release</a> section for the latest versions.</p>
-
+<br>
 <ol>
   <li>Download and run the MinGW setup program,
   <a href="http://downloads.sourceforge.net/mingw/MinGW-5.1.3.exe">MinGW-5.1.3.exe</a>.
-  Select download and install the MinGW base tools and the g++ compiler.
+  <li>Select download and install the MinGW base tools and the g++ compiler.
   You may select the Current or Candidate version of these tools.
   You may also install any of the other available compilers as well.
-  Do not install the MinGW Make feature as the MSYS version of make from step 3
-  is a more complete implementation of make.</li>
+  <p><b>Do not install the MinGW Make feature</b> as the MSYS version of make from step 3
+  is a more complete implementation of make.</p></li>
   <li>The MinGW setup program currently does not install the gdb debugger.
-  To do so, download the
+  To install the debugger, download the file from the following location: 
   <a href="http://downloads.sourceforge.net/mingw/gdb-6.6.tar.bz2">gdb-6.6.tar.bz2</a>
-  file and extract it's contents to the same location where you installed MinGW.</li>
-  <li>If you plan on using Makefile projects, download and run the
+  <li>Extract the contents of the file gdb-6.6.tar.bz2 to the same location where you installed MinGW.</li>
+  <li>If you want to use Makefile projects, download and run the setup program from the following location: 
   <a href="http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe">MSYS-1.0.10.exe</a>
-  setup program. MSYS provides an implementation of make and related command line tools.
+  <p>MSYS provides an implementation of make and related command line tools.
   This is not required for other types of projects with the MinGW tool chain,
   which use CDT's internal build tools to perform the build.</li>
 </ol>
-
+</ul>
+<br>
 <h3>Other Platforms</h3>
-<p>The GNU tool chain is supported on all platforms that the CDT supports.
-Please see you're platform vendor for instructions on how to install the GNU tool chain
-on your platform.</p>
+<p>The GNU tool chain is supported on all platforms that the CDT supports. For instructions about installing the GNU tool chain
+on your platform, see your platform vendor.</p>
 
 <p align="left"> <img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21">  <br>
   <a href="../concepts/cdt_o_home.htm">CDT Home</a><br>
@@ -78,7 +81,7 @@ on your platform.</p>
 <p align="left"> <img border="0" src="../images/ngtasks.gif" ALT="Related tasks"> <br>
   <a href="../tasks/cdt_t_manualbuild.htm">Building Manually</a>
 </p>
-<p><img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" > 
+<p><img src="../images/ng00_04a.gif" ALT="QNX Copyright Statement" > 
 </p>
 </body>
 
diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_projects.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_projects.htm
index a53e61613b5..ee1e9c76a78 100644
--- a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_projects.htm
+++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_projects.htm
@@ -46,13 +46,13 @@ at any time for existing project. Use <a href="../reference/cdt_o_proj_prop_page
 </ul>
 
 <p>After you select a template, the result is a project with only the meta-data files required for the project type. You are expected to modify these source files, as required, and provide source files for the project's target.</p><p>The makefile for the <b>Executable</b> project type is automatically created by the CDT.</p>
-		<li><b>Shared Library</b> - An executable module that is compiled and linked separately. When you create a project that uses a shared library (<fname>libxx.so</fname>), you define your shared library's project as a Project Reference for your application. For this project type, the CDT combines object files together and joins them so they're relocatable and can be shared by many processes. Shared libraries are named using the format
-<fname>libxx.so.</fname><var>version</var>, where
+		<li><b>Shared Library</b> - An executable module that is compiled and linked separately. When you create a project that uses a shared library (libxx.so), you define your shared library's project as a Project Reference for your application. For this project type, the CDT combines object files together and joins them so they're relocatable and can be shared by many processes. Shared libraries are named using the format
+libxx.so.<var>version</var>, where
 <var>version</var> is a number with a default of 1. The
-<fname>libxx.so</fname> file usually is a symbolic link to the
+libxx.so file usually is a symbolic link to the
 latest version.</p><p>The makefile for this project type is automatically created by the CDT.
-		<li><b>Static Library</b> - A collection of object files that you can link into another application (<fname>libxx.a</fname>). The CDT combines object files (i.e. <fname>*.o</fname>)
-into an archive (<fname>*.a</fname>) that is directly linked into an
+		<li><b>Static Library</b> - A collection of object files that you can link into another application (libxx.a). The CDT combines object files (i.e. *.o)
+into an archive (*.a) that is directly linked into an
 executable.</p><p>The makefile for this project type is automatically created by the CDT.
 		<li><b>Makefile Project</b> - Creates an empty project without the meta-data files. This selection is useful for importing and modifying existing makefile-based projects; a new makefile is not created for this project type. 
 	</ul> 
diff --git a/doc/org.eclipse.cdt.doc.user/getting_started/cdt_w_existing_code.htm b/doc/org.eclipse.cdt.doc.user/getting_started/cdt_w_existing_code.htm
index 803143754a5..31ed4a873f9 100644
--- a/doc/org.eclipse.cdt.doc.user/getting_started/cdt_w_existing_code.htm
+++ b/doc/org.eclipse.cdt.doc.user/getting_started/cdt_w_existing_code.htm
@@ -36,29 +36,25 @@ you're importing:
 </p>
 
 <ul>
-    <li>
-    <xref xid="#cvs_existing_project">an existing C/C++ project</xref>
+    <li>an existing C/C++ project
     </li>
 
-    <li>
-    <xref xid="#cvs_existing_code">existing C/C++ code that isn't part
-    of a project</xref>
+    <li>existing C/C++ code that isn't part of a project
     </li>
 
     <li>
-    <xref xid="#cvs_code_into_project">existing C/C++ code that needs
-    to be added to an existing project</xref>
+    existing C/C++ code that needs to be added to an existing project
     </li>
 </ul>
 
-<h3 id="cvs_existing_project">Importing a C/C++ project from CVS</h3>
+<h3>Importing a C/C++ project from CVS</h3>
 
 <p>
 To check out an existing C/C++ project from the CVS repository into your workspace, right-click the project in the CVS Repositories view, and select <b>Check Out</b> from the menu. A project with the same name as the CVS module is checked out in to your workspace. 
 </p>
 
 
-<h3 id="cvs_existing_code">Importing C/C++ code from CVS</h3>
+<h3>Importing C/C++ code from CVS</h3>
 
 <p>
 To check out existing C/C++ code that is not part of a project:
@@ -74,11 +70,7 @@ To check out existing C/C++ code that is not part of a project:
     The Check Out As wizard dispalys.
     </p>
 
-    <figure>
-    <img src="images/cvs-checkout-as.gif" alt="Check Out As">
-    <caption>The Check Out As wizard.</caption>
-    </figure>
-    </li>
+     </li>
 
     <li>
     Choose how to check out this project:
@@ -103,7 +95,7 @@ To check out existing C/C++ code that is not part of a project:
 
         <li>
         as a Standard Make C/C++ Project &ndash; if you need to create your own
-        <fname>Makefile</fname> to integrate with an existing build
+        Makefile to integrate with an existing build
         process
         </li>
     </ul>
@@ -111,13 +103,13 @@ To check out existing C/C++ code that is not part of a project:
     <p>
     Choose the workspace location for this project, then the CVS
     tag to check out.  
-    <li>Click <ui>Finish</ui> to exit the <ui>Check Out As</ui> dialog.
+    <li>Click <b>Finish</b> to exit the <b>Check Out As</b> dialog.
     </p>
 
     <li>Click <ui>Next</ui> to continue.
 </ol>
 
-<h3 id="cvs_code_into_project">Importing C/C++ code into an existing project</h3>
+<h3>Importing C/C++ code into an existing project</h3>
 
 <p>
 To import a directory full of C/C++ code into an existing project:
@@ -185,7 +177,7 @@ recreate it specifying a different non-default location.
 <p>Another approach would be to create a C/C++ Project and then import your 
 existing file system.
 
-For more information, see <b>Workbench User Guide &gt; Tasks &gt; Importing &gt; 
+For more information about importing, see <b>Workbench User Guide &gt; Tasks &gt; Importing &gt; 
 Importing resources from the file system</b>.</p>
 
 <p>This approach copies the files from your file system to an Eclipse Workbench 
diff --git a/doc/org.eclipse.cdt.doc.user/getting_started/cdt_w_newproj.htm b/doc/org.eclipse.cdt.doc.user/getting_started/cdt_w_newproj.htm
index cbb09f25d75..56b682bfb41 100644
--- a/doc/org.eclipse.cdt.doc.user/getting_started/cdt_w_newproj.htm
+++ b/doc/org.eclipse.cdt.doc.user/getting_started/cdt_w_newproj.htm
@@ -37,13 +37,13 @@ that can incrementally compile source files as  they are changed.</p>
 </ul>
 
 <p>After you select a template, the result is a project with only the meta-data files required for the project type. You are expected to modify these source files, as required, and provide source files for the project's target.</p><p>The makefile for the <b>Executable</b> project type is automatically created by the CDT.</p>
-		<li><b>Shared Library</b> - An executable module that is compiled and linked separately. When you create a project that uses a shared library (<fname>libxx.so</fname>), you define your shared library's project as a Project Reference for your application. For this project type, the CDT combines object files together and joins them so they're relocatable and can be shared by many processes. Shared libraries are named using the format
-<fname>libxx.so.</fname><var>version</var>, where
+		<li><b>Shared Library</b> - An executable module that is compiled and linked separately. When you create a project that uses a shared library (libxx.so), you define your shared library's project as a Project Reference for your application. For this project type, the CDT combines object files together and joins them so they're relocatable and can be shared by many processes. Shared libraries are named using the format
+ libxx.so.<var>version</var>, where
 <var>version</var> is a number with a default of 1. The
-<fname>libxx.so</fname> file usually is a symbolic link to the
+libxx.so file usually is a symbolic link to the
 latest version. The makefile for this project type is automatically created by the CDT.
-		<li><b>Static Library</b> - A collection of object files that you can link into another application (<fname>libxx.a</fname>). The CDT combines object files (i.e. <fname>*.o</fname>)
-into an archive (<fname>*.a</fname>) that is directly linked into an
+		<li><b>Static Library</b> - A collection of object files that you can link into another application (libxx.a). The CDT combines object files (i.e. *.o)
+into an archive (*.a) that is directly linked into an
 executable. The makefile for this project type is automatically created by the CDT.
 		<li><b>Makefile Project</b> - Creates an empty project without the meta-data files. This selection is useful for importing and modifying existing makefile-based projects; a new makefile is not created for this project type. 
 	</ul>
author	Doug Schaefer	2007-06-21 19:51:44 +0000
committer	Doug Schaefer	2007-06-21 19:51:44 +0000
commit	e27fb609c84f0ef38dd09e90fb24af69be0f3ed5 (patch)
tree	23460c10f996dcdda51094bbb3ca8ef0dea651c7 /doc
parent	ecc0241a09ba99a55e2c97d244b5fd5d7c9267ff (diff)
download	org.eclipse.cdt-e27fb609c84f0ef38dd09e90fb24af69be0f3ed5.tar.gz org.eclipse.cdt-e27fb609c84f0ef38dd09e90fb24af69be0f3ed5.tar.xz org.eclipse.cdt-e27fb609c84f0ef38dd09e90fb24af69be0f3ed5.zip