Gentoo Logo

GDP Status Report

Content:

1.  Status Reports

Preliminaries

This is the status of the Gentoo Documentation Project. It will be posted regularly, but not with a static frequency. All questions can be posted to gentoo-doc@gentoo.org or to me personally.

The Gentoo Documentation Project, from now on abbreviated to GDP, has its own project page (just like almost all other Gentoo projects). You can find it at http://www.gentoo.org/proj/en/gdp.

Content

This status mail will briefly discuss the following tasks, objectives and/or projects related to the GDP:

2.  New/Updated Documentation

Users who are seeking a distributed file system can look at our updated OpenAFS Guide for installation and configuration instructions of the powerful Open Andrew File System which got updated to the current release, and extended quite a bit with additional documented functions.

Also, our KDE Split Ebuilds document has been updated with some information about the possible new build scheme that KDE 4 will use, and confcache (an improvement for repeated autoconf-generated configure script executions). The FAQ on how to unmerge older KDE versions has been moved out...

Talking about KDE, our KDE Configuration Guide has been updated to reflect the stabilisation of KDE 3.4 in the Portage tree and, with that, the introduction of new KDE packages. The update also improves the hal and dbus descriptions. And that's not all, the guide now contains information about maintaining several KDE versions simultaneously and includes the instructions about deinstalling KDE which were previously in the KDE Split Ebuilds guide.

Readers interested in virtualisation should really take a look at the updated User-Mode Linux Guide which gives some additional help with virtual networks within the run-linux-in-linux context.

Upcoming support for the FreeBSD platform is on its way. This is clearly reflected upon the short guide to Gentoo/FreeBSD which is getting larger and larger; the last updates include more verbose installation instructions and kernel configuration instructions, amongst various smaller updates which keep the documentation up to par with the codebase.

We now have a Gentoo GCC Upgrading Guide which replaces the old guide which was stored in the x86/Base Project space. We never said upgrading GCC is painless, but with guides like these it is just a matter of reading, learning and executing.

Other documents that have been updated are:

  • The Gentoo Home Router HOWTO now tells the reader what kernel configuration is required for ADSL/PPPoE and includes a new section on connecting to one or more networks.
  • The Gentoo Printing HOWTO gives more accurate information for PNM2PPA and HPLIP users.
  • The Gentoo FAQ informs its readers about the use of a statical /dev structure.
  • The Gentoo Java Guide has been updated to reflect the use of the nsplugin flag.
  • Users of mrxvt and xterm can now find more accurate Unicode information about their tool in the Gentoo UTF-8 document.
  • The Gentoo Handbook has been updated with a few changes, like
    • broadcasting information for the interfaces
    • improved kernel installation instructions
    • timezone copying instead of symlinking
    • fixed grub.conf examples with respect to the /boot location
    • 2005.1-r1 release changes (which is mostly a change of media)
    • improved grub-install information
    • introducing RSYNC_EXCLUDEFROM for rsync exclusion
    • new references to the catalyst documentation
    • support for the no-nptl profile for 2.4 kernels
    • deprecation of the --udev option for genkernel
  • The Gentoo Security Handbook has had a touch-up on Aide (a tool for intrusion detection) and some smaller fixes.
  • OpenOffice 2.0.x doesn't build on 64-bit AMD64 systems either, says the Gentoo AMD64 FAQ now.
  • The Gentoo Virtual Mailhosting Guide has a fix where we forgot to put the FLUSH PRIVILEGES SQL command.
  • The Grub Error Guide fixes a forgotten chroot command.

3.  Moving Stage1/Stage2 To Gentoo FAQ

Historically, the Gentoo Handbook contained all the installation methods that were possible to obtain a Gentoo installed environment. At first, this included the Knoppix and other alternative installation instructions. Those were moved to the Alternative Installation Guide because they were interfering with the "regular" installation method that Gentoo promoted.

Now, due to various bugs and, more importantly, because the instructions were (and still are) flawed under some circumstances, the bootstrapping and system-emerge steps (also known as the stage1 and stage2 installation procedures) have been moved to the Gentoo FAQ.

The idea is to keep the Gentoo Handbook for the official installation instructions which are supported by the release engineering team and fully documented and maintained by the documentation project, while the other installation instructions are maintained by the documentation project but not official.

Work is on the way to create a bootstrapping guide, detailing why bootstrapping is needed, when and how to create installation media for an unsupported platform, etc. People with knowledge about this subject and who are interested in providing feedback can take a look at the current draft and mail Sven Vermeulen with their much appreciated feedback.

4.  Removed Documentation

The MacOS Guide has been removed; people are now referred to the Portage for Darwin/Mac OS X project.



Print

Page updated December 16, 2005

Summary: Status report of the GDP project

Sven Vermeulen

Donate to support our development efforts.

Copyright 2001-2014 Gentoo Foundation, Inc. Questions, Comments? Contact us.