os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Document 'MFC after:'.

Browse source 
Submitted by:	Mike Barcroft <mike@q9media.com>
This commit is contained in:
Dima Dorfman 2001-07-15 05:22:50 +00:00
parent d256565232
commit f5838bd6ef
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=9912
1 changed files with 42 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
en_US.ISO8859-1/articles/committers-guide/article.sgml
View file

@ -2,6 +2,9 @@
<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
%man;
<!ENTITY % freebsd PUBLIC "-//FreeBSD//ENTITIES DocBook Miscellaneous FreeBSD Entities//EN">
%freebsd;
<!ENTITY % authors PUBLIC "-//FreeBSD//ENTITIES DocBook Author Entities//EN">
%authors;
@ -19,7 +22,7 @@
</author>
</authorgroup>
<pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/committers-guide/article.sgml,v 1.77 2001/07/13 15:36:28 nik Exp $</pubdate>
<pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/committers-guide/article.sgml,v 1.78 2001/07/14 03:38:03 obrien Exp $</pubdate>
<copyright>
<year>1999</year>
@ -519,11 +522,11 @@
</itemizedlist>
<para>You'll almost certainly get a conflict because
of the <literal>$Id: article.sgml,v 1.78 2001-07-14 03:38:03 obrien Exp $</literal> (or in FreeBSD's case,
of the <literal>$Id: article.sgml,v 1.79 2001-07-15 05:22:50 dd Exp $</literal> (or in FreeBSD's case,
<literal>$FreeBSD<!-- stop expansion -->$</literal>) lines, so you'll have to edit
the file to resolve the conflict (remove the marker lines and
the second <literal>$Id: article.sgml,v 1.78 2001-07-14 03:38:03 obrien Exp $</literal> line, leaving the original
<literal>$Id: article.sgml,v 1.78 2001-07-14 03:38:03 obrien Exp $</literal> line intact).</para>
the second <literal>$Id: article.sgml,v 1.79 2001-07-15 05:22:50 dd Exp $</literal> line, leaving the original
<literal>$Id: article.sgml,v 1.79 2001-07-15 05:22:50 dd Exp $</literal> line intact).</para>
</listitem>
<listitem>
@ -2215,6 +2218,15 @@ cvs add: use 'cvs commit' to add this file permanently
<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
<acronym>MFC</acronym> at a later date, specify the
number of days, weeks, or months after which an
<acronym>MFC</acronym> is planned.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
@ -2272,13 +2284,36 @@ Approved by: <replaceable>abc</replaceable></programlisting>
Obtained from: OpenBSD</programlisting>
</example>
<example>
<title>Commit log for a change to &os.current; with a planned
commit to &os.stable; to follow at a later date.</title>
<para>You want to commit some code which will be merged from
&os.current; into the &os.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 an <acronym>MFC</acronym> is
planned. The <replaceable>weeks</replaceable> option may be
<literal>day</literal>, <literal>days</literal>,
<literal>week</literal>, <literal>weeks</literal>,
<literal>month</literal>, <literal>months</literal>,
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 <acronym>MFC</acronym> after one month to
allow adequate testing.</para>
<para>The extra information to include in the commit would look
something like</para>
@ -2286,7 +2321,8 @@ Obtained from: OpenBSD</programlisting>
<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>