Welcome to the paludis-tools documentation!

paludis-tools is a set of little utilites for use with the Gentoo package manager paludis, available freely under the terms of the GNU GPL 2 (see Licensing for details). As of now the following programs are provided:

plog – a paludis log analyzer
Analyzes a paludis logfile and extracts various sorts of information from it.
pelog – a elog file manager
Manage elog files written by ebuilds.
pquery – Metadata client
Queries package metadata and associated information.
pclean – a paludis distfile cleaner
Finds and removes unused distfiles.

Installation

The current release is paludis-tools 0.5, available in the Python Package Index. Refer to the Changelog for a list of important changes since the last release [1].

Detailed installation instructions are available to assist you with the paludis-tools installation.

Documentation

Detailed documentation about the provided programs is available:

API documentation for the underlying python modules is also provided. Developers are encouraged to make use of this API in their own scripts.

Note

All documentation on this page refers to the current development state of the version 0.5 series, not to the latest release in this series. You may notice slight differences to the 0.5 release. Please refer to the changelog to identify these differences.

Contribution and Development

Please report issues and feature requests to the issue tracker [2].

Development of paludis-tools happens on GitHub. The complete source code is available in a git repository:

git clone git://github.com/lunaryorn/paludis-tools.git

Fell free to clone and edit, or to fork the repository on GitHub. Pull requests and patches are very welcome!

paludis-tools is also listed on Ohloh. This site provides some metrics and statistics about the source code and the development activity in paludis-tools. It might help you to get an idea of source code quality and complexity.

Footnotes

[1]A detailed list of changesets is also available.
[2]Please assign proper labels to the issue and provide detailed information about the issue. If possible, include copied and pasted output from the programs, or a code example demonstrating the issue.

Table Of Contents

Next topic

plog – a paludis log analyzer