Red Hat Bugzilla – Bug 430400
[RFE] Please include more documentations for yum plugins
Last modified: 2008-05-30 11:12:09 EDT
Description of problem:
Many yum plugins don't provide a documentation with examples how to use them
and most of them also don't explain the additional configuration settings in
their config files in /etc/yum/pluginconf.d/ .
For some of them this may be ok because they are only used by "advanced users"
but others may be also used by "normal users" (like fastestmirror or
basearchonly and esp. skip-broken).
In my opinion it would be good to documentate the variables in the config
files. And also a manpage with additional informations and examples would help
a lot to understand how the plugins work.
No documentation or manpage:
config files without description:
Version-Release number of selected component (if applicable):
You are right, most of the plugins could need some documentation, man pages etc.
But most coder thinks coding is more fun, than writing docs, no excuse but just
Maybe we should think about not adding new plugins if there is no docs :)
Here is a good start that Tim has made on the docs.