r6453 - trunk/edguide

bdubbs at linuxfromscratch.org bdubbs at linuxfromscratch.org
Sun Jan 21 17:54:51 PST 2007


Author: bdubbs
Date: 2007-01-21 18:54:51 -0700 (Sun, 21 Jan 2007)
New Revision: 6453

Modified:
   trunk/edguide/chapter01.xml
   trunk/edguide/chapter02.xml
   trunk/edguide/chapter04.xml
   trunk/edguide/chapter05.xml
   trunk/edguide/general.ent
Log:
Add recommendation to chack man pages for Incorrect or Non-Displayable Encoding.  Update guide to reflect Trac ticketing system.

Modified: trunk/edguide/chapter01.xml
===================================================================
--- trunk/edguide/chapter01.xml	2007-01-21 19:42:03 UTC (rev 6452)
+++ trunk/edguide/chapter01.xml	2007-01-22 01:54:51 UTC (rev 6453)
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
-
-  <!ENTITY blfs-bugzilla "http://blfs-bugs.linuxfromscratch.org">
+  <!ENTITY % general-entities SYSTEM "general.ent">
+  %general-entities;
 ]>
 
 <chapter id="chapter01">
@@ -24,27 +24,28 @@
 package.</para>
 
 <para>BLFS development takes place using three main systems.  First, the
-mailing lists <emphasis>blfs-dev</emphasis>, <emphasis>blfs-book</emphasis>, and
-(to a lesser extent) <emphasis>blfs-support</emphasis>.  Second, the Bugzilla
-tracking system, and third the <application>Subversion</application> server
-where the book itself is stored.  All of these services are provided by the
-server <emphasis>linuxfromscratch.org</emphasis> also known as
-<emphasis>belgarath.linuxfromscratch.org</emphasis>.  This single server
-provides mailing lists, web hosting, <application>Subversion</application>
-hosting, ftp hosting, the Bugzilla system, and basically everything we use to
-work on the BLFS project.</para>
+mailing lists <emphasis>blfs-dev</emphasis>, <emphasis>blfs-book</emphasis>,
+and (to a lesser extent) <emphasis>blfs-support</emphasis>.  Second, the Trac
+Wiki and ticket tracking system, and third the
+<application>Subversion</application> server where the book itself is stored.
+All of these services are provided by the server
+<emphasis>linuxfromscratch.org</emphasis> also known as
+<emphasis>quantum.linuxfromscratch.org</emphasis>.  This single server provides
+mailing lists, web hosting, <application>Subversion</application> hosting, ftp
+hosting, the Trac system, and basically everything we use to work on the BLFS
+project.</para>
 
-<para>Anyone can subscribe to any of the mailing lists provided by belgarath.
+<para>Anyone can subscribe to any of the mailing lists provided by quantum.
 We're not going to describe that (or the lists in detail) here as there is a
 good description at <ulink
 url="http://www.linuxfromscratch.org/mail.html"/>.</para>
 
 
-<para>The Bugzilla bug-tracking system for BLFS can be found at <ulink
-url="&blfs-bugzilla;"/>.  In order to be able to add, remove and edit bugs, you
+<para>The Trac Wiki and ticket tracking system for BLFS can be found at <ulink
+url="&blfs-trac;"/>.  In order to be able to add, remove and edit tickets, you
 need to have an account and make sure you are logged in whenever you wish to
-perform such an action.  You can query and read the bug database without
-logging in or creating a user.  Note that all bugzilla messages are copied to
+perform such an action.  You can query and read the ticket database without
+logging in or creating a user.  Note that all Trac tickets are copied to
 the <emphasis>blfs-book</emphasis> mailing list and that all editors should be
 subscribed to this and the <emphasis>blfs-dev</emphasis> list at a
 minimum.</para>

Modified: trunk/edguide/chapter02.xml
===================================================================
--- trunk/edguide/chapter02.xml	2007-01-21 19:42:03 UTC (rev 6452)
+++ trunk/edguide/chapter02.xml	2007-01-22 01:54:51 UTC (rev 6453)
@@ -19,7 +19,7 @@
 (and some others).  The tree which we are interested in for BLFS editing is
 (unsurprisingly) the BLFS tree.  A complete list of the modules which are
 available can be found using the interface at <ulink
-url="http://svn.linuxfromscratch.org/viewcvs.cgi/?root=BLFS"/>.</para>
+url="http://wiki.linuxfromscratch.org/blfs/browser/trunk"/>.</para>
 
 <para>There are two types of SVN access provided to the BLFS tree: anonymous
 read-only access which anyone can use and read-write access granted to active
@@ -73,7 +73,7 @@
 <para>Once you have this setup, try to checkout the BLFS tree using:
 <screen><userinput>svn co svn+ssh://linuxfromscratch.org/BLFS/trunk/</userinput></screen>
 If this works, you'll get a nice trunk directory listing and you have
-your own sandbox!.  You also have write access so from now on be extra
+your own sandbox!  You also have write access so from now on be extra
 careful but note that <emphasis>no</emphasis> changes will be made until
 you use a <userinput>svn commit</userinput> command.</para>
 

Modified: trunk/edguide/chapter04.xml
===================================================================
--- trunk/edguide/chapter04.xml	2007-01-21 19:42:03 UTC (rev 6452)
+++ trunk/edguide/chapter04.xml	2007-01-22 01:54:51 UTC (rev 6453)
@@ -28,7 +28,7 @@
    <userinput>remove</userinput>ed.</para></listitem>
 <listitem><para>Check that the book renders properly.</para></listitem>
 <listitem><para>Commit it!</para></listitem>
-<listitem><para>Update bugzilla to reflect the changes</para></listitem>
+<listitem><para>Update ticket to reflect the changes</para></listitem>
 </itemizedlist>
 
 </section>
@@ -42,6 +42,26 @@
 twice) very quickly when someone noticed.... </confession mode>
 So learn from our mistakes - check <emphasis>everything</emphasis>.</para>
 
+<para>It is also a good practice to check any installed man pages for
+encoding not supported by the LFS system.  This can be checked by running
+the following script with the current package manpages as arguments:</para>
+
+<screen>#!/bin/sh
+# Begin checkman.sh
+# Usage: find /usr/share/man -type f | xargs checkman.sh
+for a in "$@"
+do
+    # echo "Checking $a..."
+    # Pure-ASCII manual page (possibly except comments) is OK
+    grep -v '.\\"' "$a" | iconv -f US-ASCII -t US-ASCII >/dev/null \
+      2>&1 && continue
+    # Non-UTF-8 manual page is OK
+    iconv -f UTF-8 -t UTF-8 "$a" >/dev/null 2>&1 || continue
+    # If we got here, we found UTF-8 manual page, bad.
+    echo "UTF-8 manual page: $a" >&2
+done
+# End checkman.sh</screen>
+
 </section>
 
 <section id="ch04-updategeneralent">
@@ -215,17 +235,13 @@
 
 </section>
 
-<section id="ch04-bugzilla">
-<title>Update bugzilla</title>
+<section id="ch04-trac">
+<title>Update the Trac Ticket</title>
 
-<para>The final part of updating the book is to update bugzilla.
+<para>The final part of updating the book is to update the Trac ticket.
 This is usually as easy as going to BLFS
-Bugzilla (<ulink url="&blfs-bugzilla;"/>), going to the bug and
-choosing Resolve bug, changing resolution to FIXED.  Note that you
-should <emphasis>not</emphasis> then go back and CLOSE or VERIFY the bug.  The
-person who VERIFYs the bug should be a different editor who has tested
-that what the bug is about has been fixed.  Basically, it's our QA
-process. A bug is CLOSEd when a new version of the book is released.</para>
+Trac (<ulink url="&blfs-trac;"/>), going to the ticket and
+changing resolution to "fixed".</para>
 
 <para>Having completed all of this, you can now go and have a rest.
 Well done, thank you and good night.</para>

Modified: trunk/edguide/chapter05.xml
===================================================================
--- trunk/edguide/chapter05.xml	2007-01-21 19:42:03 UTC (rev 6452)
+++ trunk/edguide/chapter05.xml	2007-01-22 01:54:51 UTC (rev 6453)
@@ -10,17 +10,17 @@
 <othername>$Author$</othername>
 <date>$Date$</date>
 </chapterinfo>
-<title>Using Bugzilla</title>
+<title>Using the Trac Ticket System</title>
 <?dbhtml filename="chapter05.html"?>
 
 <section id="ch05-introduction">
 <title>Introduction</title>
 
 <para>This chapter covers the things you need to do when you are using
-Bugzilla for entering new bugs into the system, and fixing/updating
-outstanding bugs.</para>
+Trac for entering new tickets into the system, and fixing/updating
+outstanding tickets.</para>
 
-<para>It's assumed you have already logged into Bugzilla before doing anything
+<para>It's assumed you have already logged into Trac before doing anything
 outlined in the following sections.</para>
 
 </section>
@@ -29,75 +29,75 @@
 <title>Adding comments</title>
 
 <itemizedlist>
-<listitem><para>Go to the bug you want to update.</para></listitem>
+<listitem><para>Go to the ticket you want to update.</para></listitem>
 
 <listitem><para>Add your additional information in the
-<emphasis>Additional Comments</emphasis> text field.</para></listitem>
+<emphasis>Comment</emphasis> text field.</para></listitem>
 
-<listitem><para>As the last step, click on the <emphasis>Commit</emphasis>
+<listitem><para>As the last step, click on the <emphasis>Submit Changes</emphasis>
 button to commit your changes to the database. A log of this will be sent
 to the blfs-book mailing list.</para></listitem>
 
 </itemizedlist>
 </section>
 
-<section id="ch05-filingbug">
-<title>Enter a new bug</title>
+<section id="ch05-createticket">
+<title>Create a new ticket</title>
 
-<para>You found a bug, or somebody else found a bug and you decided to add
-it to Bugzilla.</para>
+<para>You found a problem, or somebody else found an issue and you decided to create
+a new ticket in Trac.</para>
 
 <itemizedlist>
-<listitem><para>Go to <ulink url="&blfs-bugzilla;"/></para></listitem>
+<listitem><para>Go to <ulink url="&blfs-trac;"/></para></listitem>
 
 <listitem><para>Select the proper <emphasis>Version</emphasis>. You most always
 will choose the <emphasis>SVN</emphasis> version.  The other versions are
 basically there only for people who don't edit the book and who want to report
-a bug against the book version they have.</para></listitem>
+an issue against the book version they have.</para></listitem>
 
-<listitem><para>Don't worry about <emphasis>Platform, OS, and Severity</emphasis>. 
-Those aren't used at the moment.</para></listitem>
+<listitem><para>Set the <emphasis>Milestone, Priority, and Severity</emphasis>
+as appropriate.  Use your own judgment on how important fixing this problem is.
+If you're not sure just leave the default. These values are periodically
+re-evaluated and changed anyway (what may be P5 a month ago may be changed to a
+P1 now because it's finally time to fix it).</para>
 
-<listitem><para>Select the <emphasis>Priority</emphasis>. Use
-your own judgment on how important fixing this bug is. If you're not sure
-just leave the default. Priorities are periodically re-evaluated and
-changed anyways (what may be P5 a month ago may be changed to a P1 now
-because it's finally time to fix it).</para>
+<para>Use the following guidelines for priorities:</para>
+  <itemizedlist>
+     <listitem><para>Blocker—An issue that prevents build a system 
+       by the book and must be fixed as soon as possible.</para></listitem>
 
-<para>Use the following guidelines:</para>
-  <itemizedlist>
-     <listitem><para>P1—Critical issue that prevents build a system 
-       by the book and must be fixed as soon as possible. Includes package 
-       updates that fix serious security holes or fix some other critical bug.</para></listitem>
-     <listitem><para>P2—Major issue but not critical in the sense you 
-       cannot build an application with it. This includes most package updates. 
-       Must be fixed before the next release.</para></listitem>
-     <listitem><para>P3—Minor issue that would be nice to have fixed 
+     <listitem><para>Critical—Package updates that fix serious security
+     holes or fix some other critical problem.</para></listitem>
+     
+     <listitem><para>Major—An important issue but not critical in the
+     sense you cannot build an application with it.  Must be fixed before the
+     next release.</para></listitem>
+     
+     <listitem><para>Normal—This includes most package updates. Should
+     be fixed before the next release, but may be postponed.
+     </para></listitem>
+     
+     <listitem><para>Minor—Issues that would be nice to have fixed 
        in the next release.</para></listitem>
-     <listitem><para>P4—Textual changes that have no impact on the 
-       installation instructions.</para></listitem>
-     <listitem><para>P5—A new, unclassified and/or unconfirmed bug.</para></listitem>
+     
+     <listitem><para>Trivial—Textual changes that have no impact on the
+     installation instructions.</para></listitem>
+
   </itemizedlist>
 </listitem>
 
-
-<listitem><para>Select the <emphasis>Initial state</emphasis>. Only select
-<emphasis>UNCONFIRMED</emphasis> if you haven't checked the matter out yet
-and are only suspecting a bug. Otherwise, leave it as
-<emphasis>NEW</emphasis></para></listitem>
-
 <listitem><para>If you don't want to assign yourself to it right away,
 leave the <emphasis>Assigned To</emphasis> field blank. It'll be assigned
-to <emphasis>blfs-book at linuxfromscratch.org</emphasis> then, until a real
+to <emphasis>blfs-book at linuxfromscratch.org</emphasis> then, until an
 editor changes that to himself.</para></listitem>
 
-<listitem><para>Fill in the other fields as appropriate,
+<listitem><para>Fill in the other fields as appropriate.
 <emphasis>Summary</emphasis> and <emphasis>Description</emphasis> are
 mandatory.</para></listitem>
 
-<listitem><para>As the last step, click on the <emphasis>Commit</emphasis>
+<listitem><para>As the last step, click on the <emphasis>Submit Ticket</emphasis>
 button to commit your changes to the database. A log of this will be sent
-to the blfs-book mailinglist.</para></listitem>
+to the blfs-book mailing list.</para></listitem>
 
 </itemizedlist>
 

Modified: trunk/edguide/general.ent
===================================================================
--- trunk/edguide/general.ent	2007-01-21 19:42:03 UTC (rev 6452)
+++ trunk/edguide/general.ent	2007-01-22 01:54:51 UTC (rev 6453)
@@ -1,6 +1,6 @@
-<!ENTITY version "20050817">
+<!ENTITY version "20070121">
 <!ENTITY releasedate "August 17th, 2005">
 
 <!ENTITY date "$Date$">
 
-<!ENTITY blfs-bugzilla "http://blfs-bugs.linuxfromscratch.org">
+<!ENTITY blfs-trac "http://wiki.linuxfromscratch.org/blfs">




More information about the blfs-book mailing list