From owner-freebsd-doc@FreeBSD.ORG Thu Apr 24 05:40:00 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 F11E0106564A for ; Thu, 24 Apr 2008 05:40:00 +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 E8EA08FC22 for ; Thu, 24 Apr 2008 05:40:00 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.14.2/8.14.2) with ESMTP id m3O5e0xo072430 for ; Thu, 24 Apr 2008 05:40:00 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.2/8.14.1/Submit) id m3O5e0GF072429; Thu, 24 Apr 2008 05:40:00 GMT (envelope-from gnats) Resent-Date: Thu, 24 Apr 2008 05:40:00 GMT Resent-Message-Id: <200804240540.m3O5e0GF072429@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, Lawrence Mayer Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 55219106567A for ; Thu, 24 Apr 2008 05:34:24 +0000 (UTC) (envelope-from nobody@FreeBSD.org) Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21]) by mx1.freebsd.org (Postfix) with ESMTP id 5F5A38FC19 for ; Thu, 24 Apr 2008 05:34:24 +0000 (UTC) (envelope-from nobody@FreeBSD.org) Received: from www.freebsd.org (localhost [127.0.0.1]) by www.freebsd.org (8.14.2/8.14.2) with ESMTP id m3O5Xv9i023954 for ; Thu, 24 Apr 2008 05:33:57 GMT (envelope-from nobody@www.freebsd.org) Received: (from nobody@localhost) by www.freebsd.org (8.14.2/8.14.1/Submit) id m3O5Xv79023953; Thu, 24 Apr 2008 05:33:57 GMT (envelope-from nobody) Message-Id: <200804240533.m3O5Xv79023953@www.freebsd.org> Date: Thu, 24 Apr 2008 05:33:57 GMT From: Lawrence Mayer To: freebsd-gnats-submit@FreeBSD.org X-Send-Pr-Version: www-3.1 Cc: Subject: docs/123043: [patch] Update to articles/problem-reports/article.sgml X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 24 Apr 2008 05:40:01 -0000 >Number: 123043 >Category: docs >Synopsis: [patch] Update to articles/problem-reports/article.sgml >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: update >Submitter-Id: current-users >Arrival-Date: Thu Apr 24 05:40:00 UTC 2008 >Closed-Date: >Last-Modified: >Originator: Lawrence Mayer >Release: 7.0R >Organization: >Environment: >Description: Patch updates articles/problem-reports/article.sgml revision 1.55 as follows: 1. Clarifies that synopses with [patch] and [maintainer update] should include the brackets 2. Adds hyperlink to web-based PR submission form >How-To-Repeat: >Fix: Apply included patch to articles/problem-reports/article.sgml revision 1.55 Patch attached with submission follows: --- Problem-reports_155.sgml 2008-04-23 21:20:23.444529600 -0700 +++ Problem-reports_156.sgml 2008-04-23 21:59:16.248937600 -0700 @@ -342,7 +342,7 @@ If you have a patch, say so. A PR with a patch included is much more likely to be looked at than one without. If you are including one, - put the string [patch] at the + put the string [patch] (including the brackets) at the beginning of the Synopsis. (Although it is not mandatory to use that exact string, by convention, that is the one that is used.) @@ -352,7 +352,7 @@ If you are a maintainer, say so. If you are maintaining a part of the source code (for instance, a port), you might consider adding the string - [maintainer update] at the beginning of + [maintainer update] (including the brackets) at the beginning of your synopsis line, and you definitely should set the Class of your PR to maintainer-update. This way @@ -521,8 +521,9 @@ you insert manual linebreaks somewhere around 70 characters, so that the web display of the PR will be readable. - Similar considerations apply if you are using the web-based - PR submittal form instead of &man.send-pr.1;. Note that + Similar considerations apply if you are using the + web-based + PR submittal form instead of &man.send-pr.1;. Note that cut-and-paste operations can have their own side-effects on text formatting. In certain cases it may be necessary to use &man.uuencode.1; to ensure that patches arrive unmodified. @@ -530,7 +531,7 @@ Finally, if your submission will be lengthy, you should to prepare your work offline so that nothing will be lost in case there is a problem submitting it. This can be an especial - problem with the web form. + problem with the web form.
@@ -638,7 +639,7 @@ The next section describes fields that are common to both - the email interface and the web interface: + the email interface and the web interface: @@ -677,10 +678,10 @@ get ignored. As noted above, if your problem report includes a patch, - please have the synopsis start with [patch]; + please have the synopsis start with [patch] (including the brackets); if this is a ports PR and you are the maintainer, you may consider adding - [maintainer update] and set the + [maintainer update] (including the brackets) and set the Class of your PR to maintainer-update. @@ -1107,7 +1108,7 @@ This will read the specified file, validate the contents, strip comments and send it off. - If you are using the web form: + If you are using the web form: Before you hit submit, you will need to fill in a field containing text that is represented in image >Release-Note: >Audit-Trail: >Unformatted: