diff --git a/en/gnome/docs/bugging.sgml b/en/gnome/docs/bugging.sgml index ce4c9b7ed7..d63cd215ca 100644 --- a/en/gnome/docs/bugging.sgml +++ b/en/gnome/docs/bugging.sgml @@ -1,126 +1,123 @@ - + ]> &header;

1. When should I make a bug report?

2. What to report?

Always report as much information as you can. Too much information is always preferable to too little information. Superfluous information can be filtered out; developers like to play guessing games with code, not with bug reports.

A good bug report should at least include the following information:

If you have a solution or a workaround for the problem, then include it into your report as well, even if you are not quite sure that it is a proper fix. Even if the fix is not quite right, it could still point others in the right direction.

3. Where to report?

Once you are sure it is a new problem, there are several ways to report a bug in GNOME running on FreeBSD: you could send a report to the freebsd-gnome mailing list, file a problem report in the FreeBSD bug reporting system, send your report to the application's developers via the GNOME bug tracking system, or any combination of those.

&footer; diff --git a/en/gnome/docs/develfaq.sgml b/en/gnome/docs/develfaq.sgml index f6007863bc..881295cbdb 100644 --- a/en/gnome/docs/develfaq.sgml +++ b/en/gnome/docs/develfaq.sgml @@ -1,173 +1,172 @@ - + ]> &header;

Contents

  1. What are development versions of GNOME all about?
  2. Should I track development versions?
  3. How do I obtain development versions of GNOME stuff?
  4. How do I keep everything up-to-date and in sync?
  5. What should I do when something does not work?
  6. How can I help with the development versions?
  7. What is the current state of development GNOME on FreeBSD

Full Text

  1. What are development versions of GNOME all about?

    The development versions are the packages released by the GNOME project that will eventually become the stable (release) versions. There are three working branches of GNOME development:

    1. STABLE - The applications and libraries in the stable branch are considered "release quality," and are the versions that appear in the FreeBSD ports tree. The current stable version is GNOME &gnomever;.
    2. DEVELOPMENT - In between stable releases are development releases. Traditionally, GNOME development releases have odd minor numbers (e.g. 2.3, &gnomedevelver;, 2.(n*2)-1). Development releases will become stable releases, and move from alpha to beta quality during their lifecycle. The development releases need testing by FreeBSD users to minimize the number of surprises when the new stable versions are committed to the FreeBSD CVS tree. This document is about the development branch. The current development branch is GNOME &gnomedevelver;.
    3. CVS - Often newer-than-new, the CVS HEAD versions of GNOME applications and libraries are alpha quality, or often completely unbuildable. The FreeBSD GNOME project pays attention to, but does not track the alpha quality code.

  2. Should I track GNOME development versions?

    If you are looking for a stable environment, absolutely not. Please only track the GNOME &gnomedevelver; branch if you wish to help identify bugs and improve the FreeBSD GNOME project. You will find little sympathy if a development-quality GNOME application eats your homework.

  3. How do I obtain the development versions of GNOME stuff?

    Marcus maintains a CVS repository where all the development versions of the GNOME components for FreeBSD are housed. Instructions for how to check out the development ports module and how to merge it into the FreeBSD ports tree reside on the entrance page to his repository. Please read carefully the instructions at http://www.marcuscom.com:8080/cgi-bin/cvsweb.cgi.

    During the development cycle, FreeBSD-specific caveats and other useful information will be sent to marcuscom-devel@marcuscom.com. If you are tracking the GNOME development branch, you must subscribe to this list. You should also consider subscribing to &email;@FreeBSD.org.

    In order to help with bug reports, be sure to add the following to /etc/make.conf so that gdb back traces contain useful information:

    -CFLAGS=	-O -g -pipe
-STRIP=
+WITH_DEBUG=yes

    GNOME has an excellent guide for getting useful back traces.

  4. How do I keep everything up-to-date and in sync?

    The short answer is that you need to use the marcusmerge script to merge the development tree with the FreeBSD ports tree. The marcusmerge script is available here, and a man page on using the script is available here. This script will merge the development ports tree into your main ports tree. From there, you can use portupgrade to upgrade from &gnomever; to &gnomedevelver; and stay up-to-date afterwards. NOTE: if this is a first-time upgrade from &gnomever; to &gnomedevelver; you must run a special portupgrade command to account for the move from X11BASE to LOCALBASE:

     portupgrade -rf glib-2\* cairo gnome-doc-utils gnome-mime-data gnome-audio

    The long answer is that keeping up-to-date with the GNOME development branch is complicated. Sometimes components change in a way that makes portupgrade fail, or causes strange end results. If you plan to track the development branch, it is a good idea to join the freebsd-gnome mailing list, as well as to join the #freebsd-gnome IRC channel on FreeNode (irc.freenode.net).

    If all of this sounds scary, or you need a desktop that "Just Works," you should stick with the stable GNOME branch.

  5. What should I do when something does not work?

    It depends. If you think the problem is truly a bug with the GNOME component, you can report a bug using bug-buddy or the GNOME Bugzilla interface. If you think the problem lies in a FreeBSD port, or is FreeBSD-specific, send email to &email;@FreeBSD.org, or report the problem on the #freebsd-gnome IRC channel on FreeNode.

    Please forward all relevant bug IDs to &email;@FreeBSD.org so we can keep track of known issues. Thanks!

  6. How can I help with the development versions?

    Now that work on &gnomedevelver; has started, we need people to install it, and test things. If you are compiling &gnomedevelver; by hand, be sure to build debugging symbols. Package users will have these symbols already.

  7. What is the current state of development GNOME on FreeBSD?

    GNOME 2.17.2 is now out, and ports and packages are up-to-date. Keep those bug reports coming.

&footer;