diff options
| author | Remko Lodder <remko@FreeBSD.org> | 2008-12-30 08:24:54 +0000 |
|---|---|---|
| committer | Remko Lodder <remko@FreeBSD.org> | 2008-12-30 08:24:54 +0000 |
| commit | a1577961829f355e9062228aaddb85f25af6ac60 (patch) | |
| tree | e105edaa808bad82dec2983f9b09b12cee045eed /en_US.ISO8859-1/articles/problem-reports | |
| parent | 9e74bc03aabf11795a51ae8668ff833a92ca5e46 (diff) | |
| download | doc-a1577961829f355e9062228aaddb85f25af6ac60.tar.gz doc-a1577961829f355e9062228aaddb85f25af6ac60.zip | |
Add some extra details to the article.
One whitespace move, because area was touched by
submitter.
PR: 130039
Submitted by: gavin
Notes
Notes:
svn path=/head/; revision=33563
Diffstat (limited to 'en_US.ISO8859-1/articles/problem-reports')
| -rw-r--r-- | en_US.ISO8859-1/articles/problem-reports/article.sgml | 32 |
1 files changed, 30 insertions, 2 deletions
diff --git a/en_US.ISO8859-1/articles/problem-reports/article.sgml b/en_US.ISO8859-1/articles/problem-reports/article.sgml index 105f1ec846..fd4d2ed04b 100644 --- a/en_US.ISO8859-1/articles/problem-reports/article.sgml +++ b/en_US.ISO8859-1/articles/problem-reports/article.sgml @@ -390,6 +390,17 @@ </listitem> <listitem> + <para>If the problem can be reproduced easily, include + information that will help a developer to reproduce it + themselves. If a problem can be demonstrated with + specific input then include an example of that input if + possible, and include both the actual and the expected + output. If this data is large or cannot be made public, + then do try to create a minimal file that exibits the + same issue and that can be included within the PR.</para> + </listitem> + + <listitem> <para>If this is a kernel problem, then be prepared to supply the following information. (You do not have to include these by default, which only tends to @@ -408,7 +419,14 @@ sense of that option</para> </listitem> <listitem> - <para>a backtrace, if one was generated</para> + <para>the full text of any backtrace, panic or other console + output, or entries in <filename>/var/log/messages</filename>, + if any were generated</para> + </listitem> + <listitem> + <para>the output of <command>pciconf -l</command> and + relevant parts of your <command>dmesg</command> output if + your problem relates to a specific piece of hardware</para> </listitem> <listitem> <para>the fact that you have read @@ -471,7 +489,17 @@ minute or two to use the web-based search engine at <ulink url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query"></ulink>. (Of course, everyone is guilty of forgetting to do this - now and then.)</para> </listitem> + now and then.)</para> + </listitem> + + <listitem> + <para><emphasis>Report only one issue per Problem + Report.</emphasis> Avoid including two or more problems + within the same report unless they are related. When + submitting patches, avoid adding multiple features or + fixing multiple bugs in the same PR unless they are closely + related—such PRs often take longer to resolve.</para> + </listitem> <listitem> <para><emphasis>Avoid controversial requests.</emphasis> |