From owner-freebsd-doc@FreeBSD.ORG Mon Dec 29 22:40:02 2008 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 728071065673 for ; Mon, 29 Dec 2008 22:40:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 4D5A38FC14 for ; Mon, 29 Dec 2008 22:40:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.14.3/8.14.3) with ESMTP id mBTMe2tP019075 for ; Mon, 29 Dec 2008 22:40:02 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.3/8.14.3/Submit) id mBTMe2sr019074; Mon, 29 Dec 2008 22:40:02 GMT (envelope-from gnats) Resent-Date: Mon, 29 Dec 2008 22:40:02 GMT Resent-Message-Id: <200812292240.mBTMe2sr019074@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Gavin Atkinson Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id B87A71065678 for ; Mon, 29 Dec 2008 22:30:14 +0000 (UTC) (envelope-from gavin@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id A54408FC08 for ; Mon, 29 Dec 2008 22:30:14 +0000 (UTC) (envelope-from gavin@FreeBSD.org) Received: from freefall.freebsd.org (gavin@localhost [127.0.0.1]) by freefall.freebsd.org (8.14.3/8.14.3) with ESMTP id mBTMUEo0012017 for ; Mon, 29 Dec 2008 22:30:14 GMT (envelope-from gavin@freefall.freebsd.org) Received: (from gavin@localhost) by freefall.freebsd.org (8.14.3/8.14.3/Submit) id mBTMUEx2012008; Mon, 29 Dec 2008 22:30:14 GMT (envelope-from gavin) Message-Id: <200812292230.mBTMUEx2012008@freefall.freebsd.org> Date: Mon, 29 Dec 2008 22:30:14 GMT From: Gavin Atkinson To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Cc: Subject: docs/130039: [patch] Add extra detail to the problem-reports article X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: Gavin Atkinson List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 29 Dec 2008 22:40:02 -0000 >Number: 130039 >Category: docs >Synopsis: [patch] Add extra detail to the problem-reports article >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Mon Dec 29 22:40:01 UTC 2008 >Closed-Date: >Last-Modified: >Originator: Gavin Atkinson >Release: FreeBSD 7.1-PRERELEASE i386 >Organization: FreeBSD >Environment: System: FreeBSD freefall.freebsd.org 7.1-PRERELEASE FreeBSD 7.1-PRERELEASE #36: Mon Dec 29 15:15:30 UTC 2008 simon@freefall.freebsd.org:/usr/src/sys/i386/compile/FREEFALL i386 >Description: Add some extra details to the problem-reports article. Note that there is a single "whitespace" fix (moving a tag) in the patch as I've touched the line immediately preceding it. Patch is also at http://people.freebsd.org/~gavin/my-prs/pr-article.diff >How-To-Repeat: N/A >Fix: --- pr-article.diff begins here --- Index: doc/en_US.ISO8859-1/articles/problem-reports/article.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/articles/problem-reports/article.sgml,v retrieving revision 1.60 diff -u -r1.60 article.sgml --- doc/en_US.ISO8859-1/articles/problem-reports/article.sgml 13 Jul 2008 14:37:24 -0000 1.60 +++ doc/en_US.ISO8859-1/articles/problem-reports/article.sgml 26 Dec 2008 19:55:17 -0000 @@ -390,6 +390,17 @@ + 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. + + + 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 - a backtrace, if one was generated + the full text of any backtrace, panic or other console + output, or entries in /var/log/messages, + if any were generated + + + the output of pciconf -l and + relevant parts of your dmesg output if + your problem relates to a specific piece of hardware the fact that you have read @@ -471,7 +489,17 @@ minute or two to use the web-based search engine at . (Of course, everyone is guilty of forgetting to do this - now and then.) + now and then.) + + + + Report only one issue per Problem + Report. 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. + Avoid controversial requests. --- pr-article.diff ends here --- >Release-Note: >Audit-Trail: >Unformatted: