Repodoc tool

1.  Introduction

What is Repodoc?

Repodoc is a tool designed to make some checks on Gentoo Docs before the developers make the changes into cvs. It tries to improve the quality and warn about usual bugs.

Repodoc uses a design based on modules in the way that, each module takes care of make an specific check. It is completely written in bash and actually uses two little programs written in C: one to check for UTF-8 errors and other to parse xml files based on libxml2.

As a complement to repodoc, you can also find in the package another tool, docman. Docman is designed to make changes on the docs and make the developer's life easier.

Repodoc is actually maintained and developed by:

• Francesc Gordillo (frangor@gmail.com)
• Fernando J. Pereda (Fernando J. Pereda)
• José Luis Rivero (José Luis Rivero)

Versions and Changes

Currently, repodoc is under heavy development. Latest version is 0.1.0

To see what's new on this release, you can always give it a look at the full list of Changes available on-line or check the ChangeLog placed on repodoc dir.

If you need to use the last version of repodoc files, the official repodoc git repository is also available via web thanks to git-web. It's located on ferdy's server server.

2.  Installation

Installing repodoc

Since the 0.1.0 version repodoc can be found in the portage tree.

You can choose between two repodoc tastes, basic taste will install a well tested version of repodoc or the live ebuild which will download and install the latest development version (do it at your own risk).

$ echo "<app-doc/repodoc-9999 ~x86" >> /etc/portage/package.keywords
$ emerge repodoc

If you like to use the latest version from our git repo, you (obviously) need to have git installed or the ebuild will ask you to install it as a dependency.

$ echo "=app-doc/repodoc-9999 ~x86" >> /etc/portage/package.keywords
$ emerge repodoc

3.  Usage

How to use repodoc?

If you want to know a bit more about the QA check tool called repodoc, read the repodoc instructions.

If you want to use the swiss army knife tool called docman, check out the docman instructions.

4.  Future and support

Bugs? Ideas? ...

If you think you've found a bug, please mail it to repodoc@gentoo-es.org. Also if you want to make a suggestion or request a new feature, we will be pleased to listen all your ideas.

Pending features

There are several features i would like to implement sometime in the future. If you have something to propose as a new feature, feel free to mail it to me and ferdy. We promise to send you a bottle of a good red Spanish wine.

1. Support to new arch conditional tags
2. Support to --remove operations (thnx to rane)
3. Support to --add operations

The contents of this document are licensed under the Creative Commons - Attribution / Share Alike license.