From bf46b5eea65a3c2c77883fce57d0f34d1fec0dd0 Mon Sep 17 00:00:00 2001 From: Tinny Ng <tng@apache.org> Date: Wed, 14 Feb 2001 14:07:55 +0000 Subject: [PATCH] Add link to Bugzilla, the new bug reporting page. Added by Pei Yong Zhang. git-svn-id: https://svn.apache.org/repos/asf/xerces/c/trunk@172531 13f79535-47bb-0310-9956-ffa450edef68 --- doc/bug-report.xml | 57 ++++++++++++++++++++++++++++++++++++ doc/build-misc.xml | 4 ++- doc/faq-other.xml | 21 ++----------- doc/feedback.xml | 21 +++++-------- doc/html/apiDocs/header.html | 2 +- doc/xerces-c_book.xml | 2 +- 6 files changed, 71 insertions(+), 36 deletions(-) create mode 100644 doc/bug-report.xml diff --git a/doc/bug-report.xml b/doc/bug-report.xml new file mode 100644 index 000000000..dd6e8109a --- /dev/null +++ b/doc/bug-report.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE s1 SYSTEM "./dtd/document.dtd"> + +<s1 title="Bug Reporting"> + + <s2 title="How to report bugs"> + <p> Please report bugs to <jump href="http://nagoya.apache.org/bugzilla/">Bugzilla</jump>, + the Apache bug database. Pick the product "Xerces-C: Apache XML parsers in C++" + using the following components: + </p> + <table> + <tr><td><em>Component</em></td><td><em>Description</em></td></tr> + <tr><td>DOM</td><td>Items specific to DOM</td></tr> + <tr><td>SAX/SAX2</td><td>Items specific to SAX or SAX2</td></tr> + <tr><td>Non-Validating Parser</td><td>General Parsing Problem</td></tr> + <tr><td>Validating Parser (DTD)</td><td>DTD related parser issue</td></tr> + <tr><td>Utilities</td><td>Items related to utilities like MessageLoader, Transcoder, NetAccessors, Platform specific utilities</td></tr> + <tr><td>Build</td><td>Problem with build, makefile, project files</td></tr> + <tr><td>Documentation</td><td>Documentation bugs such as FAQ, Programming Guide</td></tr> + <tr><td>Samples/Tests</td><td>Samples or test cases related issues</td></tr> + <tr><td>Miscellaneous</td><td>Items not covered in other categories</td></tr> + </table> + <p>A copy of your bug report is sent automatically to the discussion list + <jump href="mailto:&XercesCEmailAddress;">Xerces-C mailing list</jump>. + </p> + </s2> + + <s2 title="Search frist"> + <p> Check the <jump href="http://nagoya.apache.org/bugzilla/">Bugzilla</jump> database + before submitting your bug report to avoid creating a duplicate report. + Even the bug has been reported already, you may add a comment to the existing report + since your contribution may lead to a quicker identification/resolution to the bug reported. + </p> + </s2> + + <s2 title="Write good bug report"> + <p> Writing a useful bug report, which makes the bug reproducible, is the first step + towards the resolution of the bug. Specifics about the bug, like + </p> + <ul> + <li>&XercesCName; version number</li> + <li>Platform</li> + <li>Operating system and version number</li> + <li>Compiler and version number</li> + <li>The XML document (or excerpt) that failed</li> + <li>The C++ application code that failed</li> + <li>Whether you built the &XercesCName; library yourself or used the + binary distribution</li> + <li>What happened</li> + </ul> + <p> + are all necessary information to allow developer to reproduce, + identify, evaluate and eventually, fix the bug, which is the very + purpose of your reporting of the bug. + </p> + </s2> +</s1> diff --git a/doc/build-misc.xml b/doc/build-misc.xml index 212565867..d21b06232 100644 --- a/doc/build-misc.xml +++ b/doc/build-misc.xml @@ -322,7 +322,9 @@ perl packageBinaries.pl -s x:\&XercesCSrcInstallDir; -o x:\temp\&XercesCInstallD can find out if others have solved this same problem before you, by checking the Apache XML mailing list archives at <jump href="http://archive.covalent.net "> - http://archive.covalent.net</jump>.</p> + http://archive.covalent.net</jump> and the + <jump href="http://nagoya.apache.org/bugzilla/">Bugzilla</jump> + Apache bug database.</p> </a> </faq> diff --git a/doc/faq-other.xml b/doc/faq-other.xml index 96d22ea26..1bfd8b0b2 100644 --- a/doc/faq-other.xml +++ b/doc/faq-other.xml @@ -81,25 +81,8 @@ <a> - <p>Check the bug list at the - <jump href="http://xml.apache.org/xerces-c/index.html">Apache Xerces-C Web - site</jump>. The problem may already be known, or even fixed. </p> - - <p>Otherwise, send the bugs to the <jump href="mailto:&XercesCEmailAddress;"> - Xerces-C mailing list</jump>. The more - information that you provide, the better our chance of understanding what - happened, or what the problem really is. Please include:</p> - - <ul> - <li>The version of &XercesCName;</li> - <li>What kind of machine</li> - <li>Operating system and OS version number</li> - <li>Whether you built the &XercesCName; library yourself or used the - binary distribution</li> - <li>The XML document (or excerpt) that fails</li> - <li>The C++ application code that failed</li> - <li>What happened</li> - </ul> + <p>See <jump href="bug-report.html">Bug Reporting</jump>. + </p> </a> </faq> diff --git a/doc/feedback.xml b/doc/feedback.xml index 17a5fa4da..5d3cd84bb 100644 --- a/doc/feedback.xml +++ b/doc/feedback.xml @@ -6,25 +6,15 @@ <p>Please browse through this bundled documentation completely. Most of the common questions have been answered in the FAQ's. Specifically, do - read the answer to "<jump href="faq-other.html#faq-4">I have a question - not covered here - who may I contact?</jump>". Browsing this + read the answer to "<jump href="faq-other.html#faq-4"> Is there any kind + of support available for Xerces-C?</jump>". Browsing this documentation, may be the quickest way to get an answer. Of course, if all else fails, as mentioned in the link above, you can post a question to the <jump href="mailto:&XercesCEmailAddress;">Xerces-C mailing list</jump>.</p> - <p>If you are reporting a defect (greatly appreciated!), please provide - the following information:</p> + <p>See <jump href="bug-report.html">Bug Reporting</jump> if you would like + to report a defect (greatly appreciated!).</p> - <ul> - <li>Version number of &XercesCName; (&XercesCVersion;?) </li> - - <li>Which OS platform/version you are using (NT4+SP4? Win98? Redhat - Linux 6.0? Solaris2.6? AIX 4.3? HP-UX10? HP-UX11?) </li> - - <li>Which compiler/version you are using (MSVC6? gcc? cc? aCC?) </li> - <li>Sample XML file that causes the bug</li> - <li>Sample DTD file (if required to recreate the bug)</li> - </ul> </s2> <s2 title="Acknowledgements"> @@ -52,6 +42,7 @@ <li>Sumit Chawla</li> <li>Chih Hsiang Chou</li> <li>Radovan Chytracek</li> + <li>Hiram Clawson</li> <li>Todd Collins</li> <li>Michael Crawford</li> <li>Murray Cumming</li> @@ -65,6 +56,7 @@ <li>William L. Hopper</li> <li>Rahul Jain</li> <li>Tom Jordahl</li> + <li>Martin Kalen</li> <li>Joe Kesselman</li> <li>Bob Kline</li> <li>Richard Ko</li> @@ -103,6 +95,7 @@ <li>Dietrich Wolf</li> <li>Kirk Wylie</li> <li>Grace Yan</li> + <li>Pei Yong Zhang</li> </ul> </s2> </s1> diff --git a/doc/html/apiDocs/header.html b/doc/html/apiDocs/header.html index c9af22b50..6006d3b6f 100644 --- a/doc/html/apiDocs/header.html +++ b/doc/html/apiDocs/header.html @@ -22,7 +22,7 @@ <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Releases" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR> <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR> - <A href="../bug-todo.html" onMouseOut="rolloverOff('side-bug-todo');" onMouseOver="rolloverOn('side-bug-todo');"><IMG alt="Bug-Todo" border="0" height="12" hspace="0" name="side-bug-todo" onLoad="rolloverLoad('side-bug-todo','../graphics/bug-todo-label-2.jpg','../graphics/bug-todo-label-3.jpg');" src="../graphics/bug-todo-label-3.jpg" vspace="0" width="120"></A><BR> + <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR> <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> diff --git a/doc/xerces-c_book.xml b/doc/xerces-c_book.xml index afc5700e2..092e7baa0 100644 --- a/doc/xerces-c_book.xml +++ b/doc/xerces-c_book.xml @@ -44,7 +44,7 @@ <document id="releases" label="Releases" source="releases.xml"/> <document id="feedback" label="Feedback" source="feedback.xml"/> - <document id="bug-todo" label="Bug-Todo" source="bug-todo.xml"/> + <document id="bug-report" label="Bug-Reporting" source="bug-report.xml"/> <document id="pdf" label="PDF Document" source="pdf-c.xml"/> <separator/> -- GitLab