aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeil Guzman2013-12-09 17:51:31 (EST)
committerNeil Guzman2013-12-10 10:03:43 (EST)
commit1b0a082d8ec47c91239f6d586e7ddf23291bb41e (patch)
tree4941575d4666a81f909e06567d68eccfa8978f33
parentb7427bd08946054c8a114494844e4db5d135b8dc (diff)
downloadorg.eclipse.linuxtools-1b0a082d8ec47c91239f6d586e7ddf23291bb41e.zip
org.eclipse.linuxtools-1b0a082d8ec47c91239f6d586e7ddf23291bb41e.tar.gz
org.eclipse.linuxtools-1b0a082d8ec47c91239f6d586e7ddf23291bb41e.tar.bz2
Specfile Editor user guide doc update for rpmlint, rpm build menues, rpm toolbar, and export. Change-Id: I4fba9e09788ca4d2f41b51cfde6d9329c8a2a6de Signed-off-by: Neil Guzman <nguzman@redhat.com> Reviewed-on: https://git.eclipse.org/r/19543 Tested-by: Hudson CI
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Specfile-Editor-Settings.html8
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html24
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm.html72
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_rpmMenu.pngbin0 -> 15874 bytes
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_rpmToolbar.pngbin0 -> 29949 bytes
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Specfileeditor_rpmlint.pngbin0 -> 48045 bytes
-rw-r--r--rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml8
7 files changed, 99 insertions, 13 deletions
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Specfile-Editor-Settings.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Specfile-Editor-Settings.html
index db075aa..af808a2 100644
--- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Specfile-Editor-Settings.html
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Specfile-Editor-Settings.html
@@ -12,7 +12,7 @@
</tr>
<tr>
<td style="width: 20%" align="left">
- <a href="Import-src-rpm-and-export-rpm-and-src-rpm.html" title="Import src.rpm and export rpm and src.rpm">
+ <a href="Import-src-rpm.html" title="Import src.rpm">
<img alt="Previous" border="0" src="../../../images/prev.gif"/>
</a>
</td>
@@ -24,7 +24,7 @@
</td>
</tr>
<tr>
- <td style="width: 20%" align="left" valign="top">Import src.rpm and export rpm and src.rpm</td>
+ <td style="width: 20%" align="left" valign="top">Import src.rpm</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">Updating This Document</td>
</tr>
@@ -187,7 +187,7 @@
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
<td style="width: 20%" align="left">
- <a href="Import-src-rpm-and-export-rpm-and-src-rpm.html" title="Import src.rpm and export rpm and src.rpm">
+ <a href="Import-src-rpm.html" title="Import src.rpm">
<img alt="Previous" border="0" src="../../../images/prev.gif"/>
</a>
</td>
@@ -203,7 +203,7 @@
</td>
</tr>
<tr>
- <td style="width: 20%" align="left" valign="top">Import src.rpm and export rpm and src.rpm</td>
+ <td style="width: 20%" align="left" valign="top">Import src.rpm</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">Updating This Document</td>
</tr>
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html
index fe2c1e4..2e709ae 100644
--- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html
@@ -18,7 +18,7 @@
</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right">
- <a href="Import-src-rpm-and-export-rpm-and-src-rpm.html" title="Import src.rpm and export rpm and src.rpm">
+ <a href="Import-src-rpm.html" title="Import src.rpm">
<img alt="Next" border="0" src="../../../images/next.gif"/>
</a>
</td>
@@ -26,7 +26,7 @@
<tr>
<td style="width: 20%" align="left" valign="top">Installing</td>
<td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right" valign="top">Import src.rpm and export rpm and src.rpm</td>
+ <td style="width: 20%" align="right" valign="top">Import src.rpm</td>
</tr>
</table><hr/>
<h1 id="General_Usage">General Usage</h1>
@@ -104,12 +104,24 @@
<dt>Source0 </dt>
<dd>This field specifies the source archive from which the package is built.</dd>
</dl>
+ <h2 id="Building_RPMs">Building RPMs</h2>
+ <p>To build RPMs, right-click on the RPM project or the Specfile Editor. Then, select <u>RPM</u> menu item from the context menu. You will be given a list of build options for the
+ <i><code>.spec</code></i> file, as well as other Specfile options.
+ </p>
+ <p>
+ <img border="0" src="images/SpecfileEditor_rpmMenu.png"/>
+ </p>
+ <h4 id="Toolbar">Toolbar</h4>
+ <p>These build options are also readily available on the toolbar menu for quicker access.</p>
+ <p>
+ <img border="0" src="images/SpecfileEditor_rpmToolbar.png"/>
+ </p>
<h2 id="rpmlint">rpmlint</h2>
<p>To enable <code>rpmlint</code> warnings, right-click on the project containing the
- <i><code>.spec</code></i> file. Then, select <u>Add/Remove rpmlint warnings</u> from the context menu. You can use this menu selection to disable <code>rpmlint</code> warnings as well.
+ <i><code>.spec</code></i> file. Then, select the <u>RPM</u> menu item. Then, <u>Add/Remove rpmlint warnings</u> from the context menu. You can use this menu selection to disable <code>rpmlint</code> warnings as well.
</p>
<p>
- <img border="0" src="images/Specfile_enable_rpmlint.png"/>
+ <img border="0" src="images/Specfileeditor_rpmlint.png"/>
</p>
<p>Enabling <code>rpmlint</code> warnings will add a new <code>rpmlint</code> builder to the project. This <code>rpmlint</code> builder checks the
<i><code>.spec</code></i> file during each project build or clean. Afterwards, the builder displays any appropriate warnings and errors in the
@@ -208,7 +220,7 @@
</a>
</td>
<td style="width: 20%" align="right">
- <a href="Import-src-rpm-and-export-rpm-and-src-rpm.html" title="Import src.rpm and export rpm and src.rpm">
+ <a href="Import-src-rpm.html" title="Import src.rpm">
<img alt="Next" border="0" src="../../../images/next.gif"/>
</a>
</td>
@@ -216,7 +228,7 @@
<tr>
<td style="width: 20%" align="left" valign="top">Installing</td>
<td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right" valign="top">Import src.rpm and export rpm and src.rpm</td>
+ <td style="width: 20%" align="right" valign="top">Import src.rpm</td>
</tr>
</table>
</body>
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm.html
new file mode 100644
index 0000000..f30b47d
--- /dev/null
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm.html
@@ -0,0 +1,72 @@
+<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <title>Specfile Editor User Guide - Import src.rpm</title>
+ <link type="text/css" rel="stylesheet" href="../../../book.css"/>
+ </head>
+ <body>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <th style="width: 100%" align="center" colspan="3">Import src.rpm</th>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="General-Usage.html" title="General Usage">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right">
+ <a href="Configuring-Specfile-Editor-Settings.html" title="Configuring Specfile Editor Settings">
+ <img alt="Next" border="0" src="../../../images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">General Usage</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Configuring Specfile Editor Settings</td>
+ </tr>
+ </table><hr/>
+ <h1 id="Import_src.rpm">Import src.rpm</h1>
+ <p>One of the features of the RPM plugin is the ability to import src.rpm files into an Eclipse project. A selection has been added to the screen that is displayed when the Eclipse File &gt; Import &gt; Other pulldown item is selected. This allows you to quickly and easily import source RPMs into the Eclipse development environment.</p>
+ <h2 id="Invoking_the_Eclipse_SRPM_Import_Feature">Invoking the Eclipse SRPM Import Feature</h2>
+ <p>Invoking the SRPM Import feature of Eclipse is a very simple matter. At the top of the Eclipse click on File which causes a pulldown menu to appear. From this menu click on Import. This causes the screen below to appear:</p>
+ <p>
+ <img border="0" src="images/Specfile_import_srpm.png"/>
+ </p>
+ <p>From this screen select Source RPM and then Next to activate the next screen shown here:</p>
+ <p>
+ <img border="0" src="images/Specfile_import_select_srpm.png"/>
+ </p>
+ <p>There are three functions that this screen must perform in order to successfully import a source RPM into Eclipse. The first thing you must do is select a source RPM to be imported using the Browse button.
+ It is used to browse around a system to the desired source RPM. Once the desired source RPM is found, either double-click on it or single-click and then click OK. The source RPMs name should now appear in the SRPM Name window.</p>
+ <p>Next, either select the already-existing project where this source RPM will be imported or click on the "Check out as a project using the New Project Wizard" button. If you select the latter, the New project wizard pops up and guides you through the process of creating a new project. Once the wizard is done, the import process begins automatically. If there is a project already created you want to import into, the Select a project window contains a list of the available Eclipse projects. Scroll to the desired project and select it so it is highlighted and click on "Finish".</p>
+ <p>Now you can use all of the resources of Eclipse on this imported project just as any other project. Notice that the source RPM that was selected for import has been copied into the project.</p><hr/>
+ <table class="navigation" style="width: 100%;" border="0" summary="navigation">
+ <tr>
+ <td style="width: 20%" align="left">
+ <a href="General-Usage.html" title="General Usage">
+ <img alt="Previous" border="0" src="../../../images/prev.gif"/>
+ </a>
+ </td>
+ <td style="width: 60%" align="center">
+ <a href="User-Guide.html" title="Specfile Editor User Guide">
+ <img alt="Specfile Editor User Guide" border="0" src="../../../images/home.gif"/>
+ </a>
+ </td>
+ <td style="width: 20%" align="right">
+ <a href="Configuring-Specfile-Editor-Settings.html" title="Configuring Specfile Editor Settings">
+ <img alt="Next" border="0" src="../../../images/next.gif"/>
+ </a>
+ </td>
+ </tr>
+ <tr>
+ <td style="width: 20%" align="left" valign="top">General Usage</td>
+ <td style="width: 60%" align="center"></td>
+ <td style="width: 20%" align="right" valign="top">Configuring Specfile Editor Settings</td>
+ </tr>
+ </table>
+ </body>
+</html> \ No newline at end of file
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_rpmMenu.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_rpmMenu.png
new file mode 100644
index 0000000..75fa9e4
--- /dev/null
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_rpmMenu.png
Binary files differ
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_rpmToolbar.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_rpmToolbar.png
new file mode 100644
index 0000000..4975a3f
--- /dev/null
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/SpecfileEditor_rpmToolbar.png
Binary files differ
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Specfileeditor_rpmlint.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Specfileeditor_rpmlint.png
new file mode 100644
index 0000000..689ced0
--- /dev/null
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Specfileeditor_rpmlint.png
Binary files differ
diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml
index 12202ee..f00c97d 100644
--- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml
+++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml
@@ -6,6 +6,9 @@
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html" label="General Usage">
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Creating_a_New_RPM_project" label="Creating a New RPM project"></topic>
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Creating_a_New_Specfile" label="Creating a New Specfile"></topic>
+ <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Building_RPMs" label="Building RPMs">
+ <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Toolbar" label="Toolbar"></topic>
+ </topic>
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#rpmlint" label="rpmlint">
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Quick_Fixes" label="Quick Fixes"></topic>
</topic>
@@ -13,9 +16,8 @@
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/General-Usage.html#Patches" label="Patches"></topic>
</topic>
</topic>
- <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm-and-export-rpm-and-src-rpm.html" label="Import src.rpm and export rpm and src.rpm">
- <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm-and-export-rpm-and-src-rpm.html#Invoking_the_Eclipse_SRPM_Import_Feature" label="Invoking the Eclipse SRPM Import Feature"></topic>
- <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm-and-export-rpm-and-src-rpm.html#Invoking_the_Eclipse_SRPM.2FRPM_Export_Feature" label="Invoking the Eclipse SRPM/RPM Export Feature"></topic>
+ <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm.html" label="Import src.rpm">
+ <topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Import-src-rpm.html#Invoking_the_Eclipse_SRPM_Import_Feature" label="Invoking the Eclipse SRPM Import Feature"></topic>
</topic>
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Specfile-Editor-Settings.html" label="Configuring Specfile Editor Settings">
<topic href="Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Specfile-Editor-Settings.html#Macro_Completion" label="Macro Completion"></topic>