View | Details | Raw Unified | Return to bug 130039
Collapse All | Expand All

(-)doc/en_US.ISO8859-1/articles/problem-reports/article.sgml (-2 / +30 lines)
Lines 390-395 Link Here
390
	    </listitem>
390
	    </listitem>
391
391
392
	    <listitem>
392
	    <listitem>
393
	      <para>If the problem can be reproduced easily, include
394
		information that will help a developer to reproduce it
395
		themselves.  If a problem can be demonstrated with
396
		specific input then include an example of that input if
397
		possible, and include both the actual and the expected
398
		output.  If this data is large or cannot be made public,
399
		then do try to create a minimal file that exibits the
400
		same issue and that can be included within the PR.</para>
401
	    </listitem>
402
403
	    <listitem>
393
	      <para>If this is a kernel problem, then be prepared to
404
	      <para>If this is a kernel problem, then be prepared to
394
		supply the following information.  (You do not
405
		supply the following information.  (You do not
395
		have to include these by default, which only tends to
406
		have to include these by default, which only tends to
Lines 408-414 Link Here
408
		    sense of that option</para>
419
		    sense of that option</para>
409
		</listitem>
420
		</listitem>
410
		<listitem>
421
		<listitem>
411
		  <para>a backtrace, if one was generated</para>
422
		  <para>the full text of any backtrace, panic or other console
423
		    output, or entries in <filename>/var/log/messages</filename>,
424
		    if any were generated</para>
425
		</listitem>
426
		<listitem>
427
		  <para>the output of <command>pciconf -l</command> and
428
		    relevant parts of your <command>dmesg</command> output if
429
		    your problem relates to a specific piece of hardware</para>
412
		</listitem>
430
		</listitem>
413
		<listitem>
431
		<listitem>
414
		  <para>the fact that you have read
432
		  <para>the fact that you have read
Lines 471-477 Link Here
471
	    minute or two to use the web-based search engine at
489
	    minute or two to use the web-based search engine at
472
	    <ulink url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query"></ulink>.
490
	    <ulink url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query"></ulink>.
473
	    (Of course, everyone is guilty of forgetting to do this
491
	    (Of course, everyone is guilty of forgetting to do this
474
	    now and then.)</para> </listitem>
492
	    now and then.)</para>
493
	</listitem>
494
495
	<listitem>
496
	  <para><emphasis>Report only one issue per Problem
497
	    Report.</emphasis> Avoid including two or more problems
498
	    within the same report unless they are related.  When
499
	    submitting patches, avoid adding multiple features or
500
	    fixing multiple bugs in the same PR unless they are closely
501
	    related&mdash;such PRs often take longer to resolve.</para>
502
	</listitem>
475
503
476
	<listitem>
504
	<listitem>
477
	  <para><emphasis>Avoid controversial requests.</emphasis>
505
	  <para><emphasis>Avoid controversial requests.</emphasis>

Return to bug 130039