From 4bed1bb27ad699bc7ddc707c0a2f9c4dcb94cfce Mon Sep 17 00:00:00 2001 From: Neil Guzman Date: Wed, 11 Dec 2013 17:05:05 -0500 Subject: RPM: createrepo update help pages Updated: https://wiki.eclipse.org/Linux_Tools_Project/SpecfileEditor/User_Guide As well as the help content pages of RPM Plug-in. Change-Id: I06c52055ab788fd7fa1914c5c31a4268c7491657 Signed-off-by: Neil Guzman Reviewed-on: https://git.eclipse.org/r/19671 Tested-by: Hudson CI Reviewed-by: Alexander Kurtakov IP-Clean: Alexander Kurtakov Tested-by: Alexander Kurtakov --- .../Configuring-Createrepo-Execution.html | 169 +++++++++++++++++ .../Configuring-Specfile-Editor-Settings.html | 16 +- .../SpecfileEditor/User_Guide/Createrepo.html | 199 +++++++++++++++++++++ .../SpecfileEditor/User_Guide/Import-src-rpm.html | 8 +- .../SpecfileEditor/User_Guide/Installing.html | 3 +- .../User_Guide/Updating-This-Document.html | 8 +- .../SpecfileEditor/User_Guide/User-Guide.html | 3 +- .../User_Guide/images/Createrepo_FormPage_1.png | Bin 0 -> 47717 bytes .../User_Guide/images/Createrepo_FormPage_2.png | Bin 0 -> 51478 bytes .../User_Guide/images/Createrepo_FormPage_3.png | Bin 0 -> 34677 bytes .../images/Createrepo_PreferencePage.png | Bin 0 -> 131980 bytes .../images/Createrepo_PropertyPage_1.png | Bin 0 -> 116029 bytes .../images/Createrepo_PropertyPage_2.png | Bin 0 -> 71107 bytes .../User_Guide/images/Createrepo_WizardPage_1.png | Bin 0 -> 29838 bytes .../User_Guide/images/Createrepo_WizardPage_2.png | Bin 0 -> 25956 bytes .../User_Guide/images/Createrepo_overview.png | Bin 0 -> 73355 bytes .../toc.xml | 13 ++ 17 files changed, 401 insertions(+), 18 deletions(-) create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Createrepo-Execution.html create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Createrepo.html create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_1.png create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_2.png create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_3.png create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PreferencePage.png create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PropertyPage_1.png create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PropertyPage_2.png create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_WizardPage_1.png create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_WizardPage_2.png create mode 100644 rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_overview.png diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Createrepo-Execution.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Createrepo-Execution.html new file mode 100644 index 0000000000..0cdbe39e98 --- /dev/null +++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Configuring-Createrepo-Execution.html @@ -0,0 +1,169 @@ + + + + + Specfile Editor User Guide - Configuring Createrepo Execution + + + + + + + + + + + + + + + + + +
+

Configuring Createrepo Execution

+

To configure createrepo command execution, navigate to Window > Preferences and select the + + Createrepo + preference node. +

+

+ +

+
+
1
+
Include the file's checksum in the files generated by the command (enabled by default)
+
+
+
2
+
Generate sqlite databases for use with yum (enabled by default)
+
+
+
3
+
Ignore symlinks of packages (disabled by default)
+
+
+
4
+
Output xml files in pretty format (disabled by default)
+
+
+
5
+
Number of workers to spawn to read RPMs. A value of 0 lets createrepo to automatically determine it for the user (0 is default)
+
+
+
6
+
Don't generate repo metadata, if their timestamps are newer than its RPMs. User should + + Update + first before executing createrepo with this enabled (disabled by default) +
+
+
+
7
+
Only import the last + + N + changelog entries from each RPM into the metadata. A value of 0 lets createrepo to automatically import all entries for the user (0 is default) +
+
+
+
8
+
Choose the checksum type used in repomd.xml and for packages in the metadata ( + + sha256 + is default) +
+
+
+
9
+
Specify which compression method to use ( + + compat + is default) +
+
+

Repository Specific Configuration

+

The createrepo command may also be configured specific to the project/repository it is being executed on. To view/enable these settings, right-click on any Createrepo project > Properties and select the + + Createrpeo + property node. +

+

Note that these settings are only visible to projects that were created with the Createrepo project or for .repo files.

+

The general project properties is almost identical to the preference page, except for allowing the user to choose if they want to enable the project properties.

+

+ +

+
+
1
+
Enable the project specific settings. If enabled, the settings set here are preferred over the workspace preferences (disabled by default)
+
+
+
2
+
A link to modify the workspace preferences. Clicking it will pop-up a new dialog box similar to that if the user were to navigate to Window > Preferences > + + Createrepo + preference node. +
+
+

Deltas

+

Deltas tells createrepo to generate deltarpms and the delta metadata. These settings are visible under the + + Createrepo + > + + Deltas + project property node. +

+

+ +

+
+
1
+
Generate deltarpms and the delta metadata for the repository (disabled by default)
+
+
+
2
+
The number of older versions to make deltas against (1 is default)
+
+
+
3
+
Max size of an RPM to run deltarpm against in MegaBytes (10 is default)
+
+
+
4
+
A list of paths to look for older packages to delta against. There can be multiple paths
+

+ + + + + + + + + + + + + + \ No newline at end of file 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 af808a2eb5..80bccd8e3e 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,21 +12,21 @@ - + Previous - + Next - Import src.rpm + Createrepo - Updating This Document + Configuring Createrepo Execution

Configuring Specfile Editor Settings

@@ -187,7 +187,7 @@ @@ -197,15 +197,15 @@ - + - + diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Createrepo.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Createrepo.html new file mode 100644 index 0000000000..9999c22c12 --- /dev/null +++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Createrepo.html @@ -0,0 +1,199 @@ + + + + + Specfile Editor User Guide - Createrepo + + + + + + + + + + + + + + + + + +
+

Createrepo

+

As mentioned previously, the createrepo tool is used in creating repositories from a set of RPMs. Eclipse allows use of this functionality in a visual and interactive environment. + The following screenshot shows the createrepo tool in action:

+

+ +

+

Creating a Repository

+

To get started, user must first create a Createrepo project via File > New > Other... and selecting + + Createrepo Wizard + under the + + Createrepo + category. You will be provided with a general project creation dialog that allows you to: 1) specify a project name; 2) specify the location in which to save the project. +

+

+ +

+

After specifying the name (and optionally the location), the user may click + + Next + which will bring them to the .repo file initialization page: +

+

+ +

+

This page creates the .repo file that allows the repository to be known to yum. There are three mandatory parts that are required to be filled before moving on:

+
+
Repo ID
+
A one-word string that uniquely identifies the yum repository
+
+
+
Name
+
A human-readable string describing the repository
+
+
+
Base URL
+
A URL to the directory where the repodata directory of a repository is located
+
+

Once these fields are filled, user can now click + + Finish + and the Createrepo project should be initialized with an empty content folder and a .repo file with the same contents as what was filled in the wizard. +

+

Getting Familiar with the Editor

+

There are 3 pages to the Createrepo editor:

+

Repository Page

+

This page manages the RPMs that the user will be creating a repository for. It allows the user to choose the RPMs they want to create a repository for and also execute the createrepo command to create the repository.

+

+ +

+
+
1 RPM list box
+
This box contains an always up-to-date listing of the RPMs within the content folder; in other words, it contains the RPMs that the user will be creating a repository for. The user may also drop RPMs onto this box which would serve the same purpose as the + + Import RPMs + button +
+
+
+
2 Import RPMs
+
Executing this button allows the user to import RPMs from the file system
+
+
+
3 Remove RPMs
+
All selected RPMs within the list will be removed. These files are also deleted from the content folder
+
+
+
4 Create Repo
+
Execute the createrepo command in the content folder. This will take command arguments as specified by the user in the + preference pages. The RPM list can be empty when executing +
+
+
+
5 Update
+
A createrepo execution with the --update command switch passed into it
+
+
+
6 Createrepo
+
Same functionality as the + + Create Repo + button, but available on the other pages as well +
+
+
+
7 Createrepo Console
+
Displays a verbose output of the execution
+
+

Metadata Page

+

This page manages the repository tags and revision number when the metadata is being generated. All new data placed into this page will be persisted on the next execution.

+

Similarly to the + + Repository + page, this page also contains the + + Update + and + + Createrepo + buttons which execute the same way. +

+

+ +

+
+
1 Revision
+
An arbitrary string for a repository revision
+
+
+
2 Tag
+
The text field in which the user specifies a tag name to add into a category
+
+
+
3 Category and Tags list box
+
Repositories can have tags for distro, content, and repo. There can be as many tags as the user specifies, but they must be unique in respect to the tags within the category they belong to
+
+
+
4 Add
+
Add the tag specified into the category selected. Unique tags are enforced, meaning that tags that already exist within the category cannot be added again. Categories cannot be added
+
+
+
5 Edit
+
Edit the selected tag in the list with the tag specified in the tag text field. Similar to + + Add + , edited tags must be unique in the category. Categories cannot be edited +
+
+
+
6 Remove
+
Remove the selected tag in the list. Categories cannot be removed
+
+

Repo Editor

+

This is a simple text editor that allows the user to modify the .repo file's contents.

+

+ +

+
+
1 Editor
+
Modify the contents of the .repo file
+

+ + + + + + + + + + + + + + \ No newline at end of file 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 index f30b47daba..4b097286a6 100644 --- 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 @@ -18,7 +18,7 @@ - + Next @@ -26,7 +26,7 @@ General Usage - Configuring Specfile Editor Settings + Createrepo

Import src.rpm

@@ -57,7 +57,7 @@ - + Next @@ -65,7 +65,7 @@ General Usage - Configuring Specfile Editor Settings + Createrepo diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Installing.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Installing.html index 8bde7cdfd2..f086f3b50e 100644 --- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Installing.html +++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/Installing.html @@ -39,7 +39,8 @@ Software Updates and Add-ons menu. For information on how to use this menu, refer to http://wiki.eclipse.org/Linux_Tools_Project/PluginInstallHelp. -


+

+

The createrepo package needs to be installed for the createrepo features to work as intended. Specfile Editor Plug-in for Eclipse will continue to work even without the createrepo command not installed. However, if installed, do note that a yum version of 3.2.23 or higher is required to use the command to its full extent.


@@ -20,7 +20,7 @@ - + @@ -33,7 +33,7 @@ @@ -45,7 +45,7 @@ - + diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html index cb14cea47a..27cfb76ea2 100644 --- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html +++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/User-Guide.html @@ -30,7 +30,8 @@ .spec files. This plug-in allows users to leverage several Eclipse GUI features in editing .spec files, including outline/quick outline view in the editor, auto-completion, highlighting, file hyperlinks, and folding.

-

In addition, the Specfile Editor Plug-in also integrates the rpmlint tool into the Eclipse interface. rpmlint is a command-line tool that helps developers detect common RPM package errors. The richer visualization offered by the Eclipse interface helps developers quickly detect, view, and correct mistakes reported by rpmlint.


+

In addition, the Specfile Editor Plug-in also integrates the rpmlint tool into the Eclipse interface. rpmlint is a command-line tool that helps developers detect common RPM package errors. The richer visualization offered by the Eclipse interface helps developers quickly detect, view, and correct mistakes reported by rpmlint.

+

RPM plugin also supports the ability to create your own repository using the createrepo command. createrepo is a command-line tool that generates an xml-based RPM metadata repository from a set of RPMs. Eclipse offers this tool bundled with the RPM plugin to allow developers to create repositories in the same environment that they create their RPMs.


diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_1.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_1.png new file mode 100644 index 0000000000..a711823120 Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_1.png differ diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_2.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_2.png new file mode 100644 index 0000000000..d889d404db Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_2.png differ diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_3.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_3.png new file mode 100644 index 0000000000..14b8dfa487 Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_FormPage_3.png differ diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PreferencePage.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PreferencePage.png new file mode 100644 index 0000000000..b0932f3e75 Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PreferencePage.png differ diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PropertyPage_1.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PropertyPage_1.png new file mode 100644 index 0000000000..ea5246800b Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PropertyPage_1.png differ diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PropertyPage_2.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PropertyPage_2.png new file mode 100644 index 0000000000..d8c3502db1 Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_PropertyPage_2.png differ diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_WizardPage_1.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_WizardPage_1.png new file mode 100644 index 0000000000..c8d54d8f06 Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_WizardPage_1.png differ diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_WizardPage_2.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_WizardPage_2.png new file mode 100644 index 0000000000..9b801dcc5c Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_WizardPage_2.png differ diff --git a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_overview.png b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_overview.png new file mode 100644 index 0000000000..c7b00ebf07 Binary files /dev/null and b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/Linux_Tools_Project/SpecfileEditor/User_Guide/images/Createrepo_overview.png 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 f00c97d2f8..554864f341 100644 --- a/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml +++ b/rpm/org.eclipse.linuxtools.rpm.ui.editor.doc/toc.xml @@ -19,6 +19,14 @@ + + + + + + + + @@ -28,6 +36,11 @@ + + + + + \ No newline at end of file -- cgit v1.2.3