[Yum-devel] [PATCH] yum-utils

Panu Matilainen pmatilai at laiskiainen.org
Tue Jan 10 18:19:30 UTC 2006


On Tue, 2006-01-10 at 10:27 -0500, Brian Long wrote:
> I'm attaching a patch which does various things for yum-utils.
> 
> 1) The Makefile now runs pydoc against each yum utility and stores the
> resulting man page in /usr/share/man/man1.  On my RHEL 4 build host,
> pydoc is not easily available stand-alone, so I temporarily
> symlinked /usr/lib/python2.3/pydoc.py to /usr/bin/pydoc.  If you python
> gurus know how to call "python pydoc" or something similar, that should
> be done in the Makefile instead.
> 
> 2) I patched repo-graph.py to make the lines a little darker than that
> which is in CVS head.  I found the default settings were a very light
> cyan color that when printed on a grayscale printer did not show up at
> all.
> 
> 3) As a proposal for man pages, I updated repoclosure with documentation
> pulled from the optparser help.  This makes repoclosure's man page show
> all the options, but it duplicates text between the doc entry and the
> optparser entry.  There has got to be a better way to do this.
> 
> 4) yum-utils.spec has been bumped to 0.4.  I added the subpackage yum-
> fastestmirror.  I also run pydoc against the changelog and fastestmirror
> plugins to generate a man page (in man3 for now).  This way you can run
> "man yum-fastestmirror".  I also include repo-graph in /usr/bin.  I
> added %config(noreplace) to the various config files.
> 
> I hope all (or portions) of this patch are acceptable.  If there is a
> way to avoid duplication of documentation between optparse help and the
> man pages, I'd like to hear about it.  I'm used to perl POD
> documentation where you can run "pod2usage" with different verbosity
> levels and get help vs. the full man page.

The other bits are fine by me and applied [*], but the man-page stuff I
don't like - we don't really want to have internals of each utility
(information about classes and defined data and whatnot) in the man
pages which is what pydoc wants to dump there. I'd rather see proper
manual pages written for the utilities than trying to figure out clever
ways of dumping optparse output to manual pages since that doesn't
really add any information, most likely it's just going to irk people
similarly to the kind of manpages which say "For full manual see info
<foo>" and nothing else :) 

[*] Except the plugin path is hardcoded to /usr/lib/yum-plugins on
purpose, using %{_libdir} yum wont find the plugins on x86_64 so I
changed back that part.

Oh and in future, please try to split up the patches by functionality,
eg. separate patch for adding a new subpackage, separate patch for
tweaking repograph colors etc. Much nicer to handle that way :)

	- Panu -




More information about the Yum-devel mailing list