conf/pluginconf.d/repoview-man.txt | 108 +++++++++++++++++++++++++++++++++++++ docs/TODO.txt | 83 ++++++++++++++++++++++++++++ 2 files changed, 191 insertions(+)

New commits: commit 5cc8d15dce1dcea6ab797dcdd2fc9fbcf57e68cb Author: Robert 'Bob' Jensen bob@fedoraunity.org Date: Wed Sep 22 11:04:52 2010 -0500

Fixing the pluginconf.d/repoview manpage to be text Adding a TODO file for reference need to add these items to the wiki

diff --git a/conf/pluginconf.d/repoview-man.txt b/conf/pluginconf.d/repoview-man.txt new file mode 100644 index 0000000..04adcc1 --- /dev/null +++ b/conf/pluginconf.d/repoview-man.txt @@ -0,0 +1,108 @@ +repoview(8) Applications/Utilities repoview(8) + + + +NAME + repoview - Make YUM repositories browseable + + +SYNOPSIS + repoview [options] repodir + + +DESCRIPTION + RepoView allows one to easily create a set of static HTML pages in a + YUM repository, allowing simple browsing of available packages. It uses + kid templating engine to create the pages and is therefore easily cus- + tomizeable. + + +OPTIONS + -i, --ignore-package NAME + Optionally ignore this package -- can be a shell-style glob. + This is useful for excluding debuginfo packages: + -i *debuginfo* -i *doc* + The globbing will be done against name-epoch-version-release, + e.g. foo-0-1.0-1 + + -x, --exclude-arch ARCH + Optionally exclude this arch. E.g.: + -x src -x ia64 + + -k, --template-dir DIR + Use an alternative directory with kid templates instead of the + default: ./templates. The template directory must contain four + required template files: index.kid, group.kid, package.kid, + rss.kid and the "layout" dir which will be copied into the + repoview directory. + + -o, --output-dir DIR + Create the repoview pages in this subdirectory inside the repos- + itory (default: "repoview") + + -s, --state-dir DIR + Create the state-tracking db in this directory (default: store + in output directory) + + -t, --title TITLE + Describe the repository in a few words. By default "RepoView" is + used. E.g.: + -t "Extras for Fedora Core 3 x86" + + -u, --url URL + Repository URL to use when generating the RSS feed. E.g.: + -u "http://fedoraproject.org/extras/5/i386" + Not providing a url will disable RSS feed generation. + + -f, --force + Regenerate the pages even if the repomd checksum has not + changed. + + -q, --quiet + Do not output anything except fatal errors. + + -c, --comps + Use an alternative comps.xml file, instead of the one specified + in repomd. + + -V, --version + Print version number and exit. + + -h, --help + Print usage message and exit. + + repodir + Where to look for the "repodata" directory. + + +FILES + /usr/bin/repoview + /usr/share/repoview/templates/* + + +EXAMPLES + The simplest invocation is: + + repoview /path/to/repository + repoview -t ’Fedora Extras 4 ix86’ /path/to/repository + + When running from cron, you want to use the -q switch: + + repoview -q /path/to/repository + + This will generate an RSS feed: + + repoview -u http://example.com/repo/i386 /path/to/repository + + +AUTHORS + Konstantin Ryabitsev icon@fedoraproject.org + + +SEE ALSO + http://linux.duke.edu/metadata + + + +Konstantin Ryabitsev 0.6 repoview(8) + diff --git a/docs/TODO.txt b/docs/TODO.txt new file mode 100644 index 0000000..1aad51e --- /dev/null +++ b/docs/TODO.txt @@ -0,0 +1,83 @@ +Plugins + We need to enable support for plugins, things like repoview would be + better suited as a plugin for example. Other options that reduce the + code in the main reflector exececutable may also be well suited as a + plugin. + +all yes/no questions + All yes/no questions should take 0,N,NO,No,no/1,Y,YES,Yes input. We + should be consistant in what we expect in the documentation also. + +logrotate + The logs can also get extensive we may want to look at reducing the + output some + +Fix the bwlimit option + Currently the bwlimit option does not seem to be working right, we need + to confirm this option in rsync. + +Hardlinking + Hardlinking saves a lot of space on your disk. We need to check this + option in the app, if true then add the rsync option and execute the + external app. Currently using freedups, will be freedup once it is + reviewed and in Fedora/EPEL. + This should be made to accept yes,y,1/no,n,0 + +Createrepo + createrepo Creates a common metadata repository. This is only needed for + "Local" or "Personal" repos. Not sure what this "-p" option is for. + +Repoview + Should be a plugin? + repoview creates a set of static HTML pages in a yum repository. If yes + read the plugin conf file /etc/reflector/pluginconf.d/repoview.conf + I think all this moves to the plugin conf file. For now they live here + because I do not know how to implement a plugin with a config file. + Not sure what the htmldir option is for, need to check this out in the + old code, also I think we would want to be able to set an option for the + templates used, repoviewtmpl would be the option for that. + # repoview-options = + # htmldir = /var/www/repoview/html + Use an alternative directory with kid templates instead of the default: + ./templates. The template directory must contain four required + template files: index.kid, group.kid, package.kid, rss.kid and the + "layout" dir. Need to read more about the kid templates, and the + processor will need to be installed so we should check that. + # repoviewtmpl = /var/www/repoview/template + +repoclosure/verifytree + Should be a plugin? + Do you want to verify your mirror integrity before the second pass to + delete obsolite files and update the repodata? Not sure this is a good + default for a public mirror, in the past we have seen broken repodata + come from upstream, I would think this might prevent that if run between + the two passes if the repo is broken we don't update the meta data. This + will not work. With the old and new files the repo would always + validate... need to come up with another idea. + # repoclosure = no + Perhaps verifytree would be better, not sure yet + # verifytree = no + +Setting the group + The group of all reflector users, at the end of our full run I think we + will need to chgrp all our files to the reflector group, unless we can + do this in rsync. + # group = reflector + +Distro Collection + We should have a runtime "collection" option. This will be helpful + when trying to fix an incoplete mirror, a new release. + +Distro Release + We should have a runtime "release" option. This will be helpful + when trying to fix an incoplete mirror, a new release. + +Distro Arch + We should have a runtime "arch" option. This will be helpful + when trying to fix an incoplete mirror, a new release. + +Local Repo + Is this a local repo? 0/1 If it is we need to run createrepo. This + option may not yet be developed. + +