aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/articles/pr-guidelines/article.xml
diff options
context:
space:
mode:
Diffstat (limited to 'en_US.ISO8859-1/articles/pr-guidelines/article.xml')
-rw-r--r--en_US.ISO8859-1/articles/pr-guidelines/article.xml74
1 files changed, 31 insertions, 43 deletions
diff --git a/en_US.ISO8859-1/articles/pr-guidelines/article.xml b/en_US.ISO8859-1/articles/pr-guidelines/article.xml
index 0333091503..083dd0dca5 100644
--- a/en_US.ISO8859-1/articles/pr-guidelines/article.xml
+++ b/en_US.ISO8859-1/articles/pr-guidelines/article.xml
@@ -1,16 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V4.5-Based Extension//EN"
- "../../../share/xml/freebsd45.dtd" [
-<!ENTITY man.edit-pr.1 "<citerefentry><refentrytitle>edit-pr</refentrytitle><manvolnum>1</manvolnum></citerefentry>">
-<!ENTITY man.query-pr.1 "<citerefentry><refentrytitle>query-pr</refentrytitle><manvolnum>1</manvolnum></citerefentry>">
-]>
-
-<article lang='en'>
+<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN"
+ "../../../share/xml/freebsd50.dtd">
+<article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<!-- :START of Article Metadata -->
- <articleinfo>
- <title>Problem Report Handling Guidelines</title>
+ <info><title>Problem Report Handling Guidelines</title>
+
- <legalnotice id="trademarks" role="trademarks">
+ <legalnotice xml:id="trademarks" role="trademarks">
&tm-attrib.freebsd;
&tm-attrib.opengroup;
&tm-attrib.general;
@@ -30,20 +26,14 @@
</abstract>
<authorgroup>
- <author>
- <firstname>Dag-Erling</firstname>
- <surname>Sm&oslash;rgrav</surname>
- </author>
-
- <author>
- <firstname>Hiten</firstname>
- <surname>Pandya</surname>
- </author>
+ <author><personname><firstname>Dag-Erling</firstname><surname>Sm&oslash;rgrav</surname></personname></author>
+
+ <author><personname><firstname>Hiten</firstname><surname>Pandya</surname></personname></author>
</authorgroup>
- </articleinfo>
+ </info>
<!-- :END of Article Metadata-->
- <section id="intro">
+ <section xml:id="intro">
<title>Introduction</title>
<para>GNATS is a defect management (bug reporting) system used by
@@ -60,7 +50,7 @@
forth.</para>
</section>
- <section id="pr-lifecycle">
+ <section xml:id="pr-lifecycle">
<title>Problem Report Life-cycle</title>
<itemizedlist>
@@ -133,7 +123,7 @@
</note>
</section>
- <section id="pr-states">
+ <section xml:id="pr-states">
<title>Problem Report State</title>
<para>It is important to update the state of a PR when certain
@@ -232,7 +222,7 @@
</note>
</section>
- <section id="pr-types">
+ <section xml:id="pr-types">
<title>Types of Problem Reports</title>
<para>While handling problem reports, either as a developer who has
@@ -263,7 +253,7 @@
PRs is used for, when a PR belongs to one of these types, and what
treatment each different type receives.</para>
- <section id="pr-unassigned">
+ <section xml:id="pr-unassigned">
<title>Unassigned PRs</title>
<para>When PRs arrive, they are initially assigned to a generic
@@ -273,7 +263,7 @@
specific &os; mailing list. Here is the current list, with
the most common ones listed first:</para>
- <table id="default-assignees-common">
+ <table xml:id="default-assignees-common">
<title>Default Assignees &mdash; most common</title>
<tgroup cols="3">
<thead>
@@ -318,7 +308,7 @@
</tgroup>
</table>
- <table id="default-assignees-other">
+ <table xml:id="default-assignees-other">
<title>Default Assignees &mdash; other</title>
<tgroup cols="3">
<thead>
@@ -385,15 +375,14 @@
<note>
<para>Since the list of individuals who have volunteered to
be the default assignee for certain types of PRs changes
- so often, it is much more suitable for <ulink
- url="http://wiki.freebsd.org/AssigningPRs">the FreeBSD wiki</ulink>.
+ so often, it is much more suitable for <link xlink:href="http://wiki.freebsd.org/AssigningPRs">the FreeBSD wiki</link>.
</para>
</note>
<para>Here is a sample list of such entities; it is probably
not complete.</para>
- <table id="common-assignees-base">
+ <table xml:id="common-assignees-base">
<title>Common Assignees &mdash; base system</title>
<tgroup cols="4">
<thead>
@@ -571,7 +560,7 @@
</tgroup>
</table>
- <table id="common-assignees-ports">
+ <table xml:id="common-assignees-ports">
<title>Common Assignees &mdash; Ports Collection</title>
<tgroup cols="4">
<thead>
@@ -735,7 +724,7 @@
because everyone assumes that the assignee is already working
on it.</para>
- <table id="common-assignees-other">
+ <table xml:id="common-assignees-other">
<title>Common Assignees &mdash; Other</title>
<tgroup cols="4">
<thead>
@@ -767,7 +756,7 @@
</section>
- <section id="pr-assigned">
+ <section xml:id="pr-assigned">
<title>Assigned PRs</title>
<para>If a PR has the <literal>responsible</literal> field set
@@ -783,7 +772,7 @@
you please.</para>
</section>
- <section id="pr-dups">
+ <section xml:id="pr-dups">
<title>Duplicate PRs</title>
<para>If you find more than one PR that describe the same issue,
@@ -795,7 +784,7 @@
the other PRs (which are now completely superseded).</para>
</section>
- <section id="pr-stale">
+ <section xml:id="pr-stale">
<title>Stale PRs</title>
<para>A PR is considered stale if it has not been modified in more
@@ -847,7 +836,7 @@
</itemizedlist>
</section>
- <section id="pr-misfiled">
+ <section xml:id="pr-misfiled">
<title>Misfiled PRs</title>
<para>GNATS is picky about the format of a submitted bug report.
@@ -913,7 +902,7 @@
</listitem>
</itemizedlist>
- <section id="pr-misfiled-followups">
+ <section xml:id="pr-misfiled-followups">
<title>Followups misfiled as new PRs</title>
<para>The first category of misfiled PRs, the one with the wrong
@@ -978,7 +967,7 @@ This was misfiled because the subject did not have the format:
avoid the next time a followup to an existing PR is sent.</para>
</section>
- <section id="pr-misfiled-format">
+ <section xml:id="pr-misfiled-format">
<title>PRs misfiled because of missing fields</title>
<para>The second type of misfiled PRs is usually the result of a
@@ -1001,7 +990,7 @@ This was misfiled because the subject did not have the format:
PR, but it is relatively easy to do most of the time.</para>
</section>
- <section id="pr-misfiled-notpr">
+ <section xml:id="pr-misfiled-notpr">
<title>Misfiled PRs that are not really problem reports</title>
<para>Sometimes a user wants to submit a report for a problem
@@ -1068,7 +1057,7 @@ This was misfiled because the subject did not have the format:
</section>
</section>
- <section id="references">
+ <section xml:id="references">
<title>Further Reading</title>
<para>This is a list of resources relevant to the proper writing
@@ -1076,9 +1065,8 @@ This was misfiled because the subject did not have the format:
<itemizedlist>
<listitem>
- <para><ulink
- url="&url.articles.problem-reports;/article.html">How to
- Write FreeBSD Problem Reports</ulink>&mdash;guidelines
+ <para><link xlink:href="&url.articles.problem-reports;/article.html">How to
+ Write FreeBSD Problem Reports</link>&mdash;guidelines
for PR originators.</para>
</listitem>
</itemizedlist>