Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 13 Jul 2001 18:48:34 -0400 (EDT)
From:      Mike Barcroft <mike@q9media.com>
To:        doc@FreeBSD.org
Subject:   Committer Guide Change [RFC]
Message-ID:  <200107132248.f6DMmYu25349@coffee.q9media.com>

next in thread | raw e-mail | index | archive | help
I would appreciate comments on the patch at the end of this
message, also available at:
http://testbed.q9media.net/freebsd/committers-guide.20010713.patch

Best regards,
Mike Barcroft

-----------------------------------------------------------------------

committers-guide.20010713.patch

o Document 'MFC after:' line in commit log.


Index: en_US.ISO8859-1/articles/committers-guide/article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/committers-guide/article.sgml,v
retrieving revision 1.77
diff -u -r1.77 article.sgml
--- en_US.ISO8859-1/articles/committers-guide/article.sgml	2001/07/13 15:36:28	1.77
+++ en_US.ISO8859-1/articles/committers-guide/article.sgml	2001/07/13 22:20:11
@@ -2215,6 +2215,13 @@
 		  <entry>The name of the project (if any) from which the code
 		    was obtained.</entry>
 		</row>
+
+		<row>
+		  <entry><literal>MFC after:</literal></entry>
+		  <entry>If you wish to receive an e-mail reminder to MFC (merge
+		    from current) at a later date, specify the number of days,
+		    weeks, or months after which a MFC is planned.</entry>
+		</row>
 	      </tbody>
 	    </tgroup>
 	  </informaltable>
@@ -2272,13 +2279,33 @@
 Obtained from:      OpenBSD</programlisting>
 	  </example>
 
+	  <example>
+	    <title>Commit log for a change to -CURRENT with a planned
+              commit to -STABLE to follow at a later date.</title>
+
+	    <para>You want to commit some code which will be merged
+	      from -CURRENT into the -STABLE branch after two weeks.</para>
+
+	    <programlisting>...
+
+MFC after:      <replaceable>2 weeks</replaceable></programlisting>
+
+	    <para>Where <replaceable>2</replaceable> is the number of days,
+	      weeks, or months after which a MFC is planned.  The
+	      <replaceable>weeks</replaceable> option may be day, days, week,
+	      weeks, month, months, or may be left off (in which case, days
+	      will be assumed).</para>
+	  </example>
+
 	  <para>In some cases you may need to combine some of these.</para>
 
 	  <para>Consider the situation where a user has submitted a PR
 	    containing code from the NetBSD project.  You are looking at the
 	    PR, but it's not an area of the tree you normally work in, so
 	    you've decided to get the change reviewed by the
-	    <literal>arch</literal> mailing list.</para>
+	    <literal>arch</literal> mailing list.  Since the change is
+	    complex you opt to MFC after one month, to allow adequate
+	    testing.</para>
 
 	  <para>The extra information to include in the commit would look
 	    something like</para>
@@ -2286,7 +2313,8 @@
 	  <programlisting>PR:                 foo/54321
 Submitted by:       John Smith &lt;John.Smith@example.com>
 Reviewed by:        -arch
-Obtained from:      NetBSD</programlisting>
+Obtained from:      NetBSD
+MFC after:          1 month</programlisting>
 	</answer>
       </qandaentry>
     </qandaset>

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200107132248.f6DMmYu25349>