1.  Gentoo Documentation Resources

Available Languages

Our documentation is also available in the following languages:

Czech | English | French | German | Italian | Japanese | Polish | Simplified Chinese | Spanish

Introduction

Welcome to the Gentoo Documentation Resources. This page will give you a quick overview on the documentation we provide. Most documentation is released under the Creative Commons - Attribution / Share Alike license, an open documentation license. All documentation should also be available in a printer-friendly format. To view this document, append ?style=printable to the URL. You'll also find a "Print" link on the top-right corner of each document.

If you find bugs in our documentation or have proposals, please use our Bugtracking System and fill in a bug report for "Documentation" or "Doc Other". These bug reports will then be handled by the Gentoo Documentation Project.

Documentation Repository

Our documentation is categorized and hierarchically navigable. If you want a quick overview of all available documentation without the additional information, please use our Documentation Listing page. We also have a full listing of all our documents with their descriptions.

2.  Gentoo Development Documentation

Gentoo Development Policies

Gentoo Linux Documentation Policy: This document contains the Gentoo Documentation Policy, which is the base document which all Gentoo Documentation developers and Contributors should know and exercise.

Developer Relations Policy Guide:Developer Relations Policy Guide

Gentoo Linux Release Guidelines: This guide covers both the QA and release guidelines for the Gentoo Linux biannual release system.

Gentoo Linux Vulnerability Treatment Policy: This document describes the policy used in Gentoo Linux to treat vulnerabilities discovered in the packages made available to our users.

Development Related Documentation

Gentoo Devmanual: The Gentoo Devmanual is a technical manual for developers which covers topics such as writing ebuilds and eclasses, and also covers policies that developers should be abiding by.

Gentoo Developer Handbook: This is the Gentoo Developer Handbook, a continuing effort to centralize development policies across Gentoo and to also outline Gentoo's development systems and procedures.

Contributing Ebuilds: This guide explains how to submit ebuild packages through the Bugzilla tracking system.

Gentoo GuideXML Guide: This guide shows you how to compose web documentation using the new lightweight Gentoo GuideXML syntax. This syntax is the official format for Gentoo documentation, and this document itself was created using GuideXML. This guide assumes a basic working knowledge of XML and HTML.

Documentation Development Tips & Tricks: Some tips & tricks that make the life for a Gentoo Documentation Developer easier

Handbook Release Guide: This guide details the process for updating the handbooks and related documentation for each new Gentoo Linux release.

How to Install Gorg: This guide describes how to install and configure gorg.

Gentoo Linux CVS Tutorial: This tutorial introduces readers to CVS, the Concurrent Versions System, used by developers around the world to develop software in a flexible and collaborative manner. Intended for those new to CVS, this tutorial will get both general users and new developers up to speed quickly. Whether you'd like to use CVS to "check out" the latest sources of a particular software package, or whether you'd like to begin using CVS as a full-fledged developer, this tutorial is for you.

Apache Developer Documentation: This document provides details about the eclasses available for developers of packages that relate to the Apache webserver.

Porting to Modular X HOWTO: This guide shows you how to port packages to use the new modular X.Org.

How to fix autotools failures: This guide aim to describe the common situations which makes autotools fail to run in an ebuild, giving advices on how to fix those.

Automagic dependencies, what they are and how to fix them: This guide aim to describe the problem of "automagic dependencies", describing the reason why they are problematic and how to handle them in most common cases.