Docman script

Repodoc Team Author

Updated December 1, 2007

1. Usage

First of all, it's important to remember that, like repodoc, some of the docman modules need to have a proper cvs gentoo structure set up. Instructions for this can be found at repodoc script page.

Code Listing 1.1: Running docman

# docman <command> [params]

Docman functionality is located into modules. Each module is designed to perform a different action, all them related to usual tasks from the editing Gentoo docs world.

To obtain the list of all supported commands (modules), you can use the --list-command docman option.

Code Listing 1.2: Obtaining the full docman command list

# docman --list-commands
Docman 0.1_beta4. List of supported commands:
 - bump       Bump doc version and/or date
 - get        Download xml docs sources from Gentoo
 - patch      Patch documents from a file or a bug number
 - sync       Sync translations metainfo with original docs

Each command need a specific syntax and support its own parameters. Help from a specific command can be found using docman --help option.

Code Listing 1.3: Asking for help from a command

# docman <command> --help

Modules

Modules are the main part of repodoc and all users should know what they do and what will be their output.

Module	Parameters	Description
Bump	(by omission, both are enabled) --version: bump version tag --date: bump date tag (options for versions bump) --major: bump major version number (first) --minor: bump minor version number (last) --mid: bump middle version number (only if exists)	The module is able to bump date and/or version xml tags. Date will be set to the current date and version will be updated depends on the doc numbering schema. Can handle "x.x.x", "x.x" and just "x" schemes.
Get	--lang-xx: download the translation instead of the original English doc, where xx is the doc lang code. --direct-url: use the provided url to get the source from it. It useful to download any doc outside of /doc/.	Download xml doc source from gentoo.org.
Patch	(by omission, both are enabled) --bug-number: bug number to get the patch from	The module is able to work directly with bugzilla, download and applying the patches in just one step. Also provide a fake-patching to know if an error is going to happened and warn the user before. Still experimental, use under your own risk.
Sync	(by omission, both are enabled) --date: sync date tag --version: sync version tag	The module syncs version and date tags on translations. It can sync version and/or date tags from an English original doc to a translation. It works just copying and overwriting translation content tag with the original doc one's.

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