svn commit: r48351 - user/jgh/committers-guide

Jason Helfman jgh at FreeBSD.org
Sun Mar 6 22:53:39 UTC 2016


Author: jgh
Date: Sun Mar  6 22:53:38 2016
New Revision: 48351
URL: https://svnweb.freebsd.org/changeset/doc/48351

Log:
  - wip

Modified:
  user/jgh/committers-guide/article.xml

Modified: user/jgh/committers-guide/article.xml
==============================================================================
--- user/jgh/committers-guide/article.xml	Sun Mar  6 20:38:56 2016	(r48350)
+++ user/jgh/committers-guide/article.xml	Sun Mar  6 22:53:38 2016	(r48351)
@@ -3056,55 +3056,55 @@ Subscribers:<co xml:id="phabricator-subs
 #
 #   $ arc diff --update <replaceable>revision</replaceable> </programlisting>
 
-    <para>Use these guidelines for filling in the template:</para>
+	<para>Use these guidelines for filling in the template:</para>
 
-	  <calloutlist>
+	<calloutlist>
 
-	    <callout arearefs="phabricator-revision">
-	      <para>The <emphasis>Revision Title</emphasis> is
-		mandatory.  This is a one line description of the
-		change.</para>
-	    </callout>
-
-	    <callout arearefs="phabricator-summary">
-	      <para>The <emphasis>Summary</emphasis> is optional.
-		However, this should contain verbatim content of the
-		commit message to be used when submitting the
-		change.</para>
-	    </callout>
-
-	    <callout arearefs="phabricator-testplan">
-	      <para>The <emphasis>Test Plan</emphasis> is optional.
-		Describe how to test the patch and how the reviewer
-		may test it.  If it is difficult to draft a plan,
-		please reconsider.</para>
-	    </callout>
-
-	    <callout arearefs="phabricator-reviewers">
-	      <para>The <emphasis>Reviewers</emphasis> is optional.
-		However, &os; committers that are expected to review
-		the patch may be listed here.  If such committers have
-		accounts on Phabricator, they will automatically be
-		notified of your submission.  Reviewers may be added
-		by their nickname:</para>
+	  <callout arearefs="phabricator-revision">
+	    <para>The <emphasis>Revision Title</emphasis> is
+	      mandatory.  This is a one line description of the
+	      change.</para>
+	  </callout>
+
+	  <callout arearefs="phabricator-summary">
+	    <para>The <emphasis>Summary</emphasis> is optional.
+	      However, this should contain verbatim content of the
+	      commit message to be used when submitting the
+	      change.</para>
+	  </callout>
+
+	  <callout arearefs="phabricator-testplan">
+	    <para>The <emphasis>Test Plan</emphasis> is optional.
+	      Describe how to test the patch and how the reviewer
+	      may test it.  If it is difficult to draft a plan,
+	      please reconsider.</para>
+	  </callout>
+
+	  <callout arearefs="phabricator-reviewers">
+	    <para>The <emphasis>Reviewers</emphasis> is optional.
+	      However, &os; committers that are expected to review
+	      the patch may be listed here.  If such committers have
+	      accounts on Phabricator, they will automatically be
+	      notified of your submission.  Reviewers may be added
+	      by their nickname:</para>
 
 	<screen>&prompt.user; <userinput>arc diff --reviewers <replaceable>nick</replaceable></userinput></screen>
 
 	    <para>or by project:</para>
 
 	<screen>&prompt.user; <userinput>arc diff --reviewers <replaceable>#portmgr</replaceable></userinput></screen>
-	    </callout>
+	  </callout>
 
-	    <callout arearefs="phabricator-subscribers">
-	      <para>Subscribers may be individuals, project groups,
-		and mailing lists.</para>
-	    </callout>
-
-	    <callout arearefs="phabricator-diffrev">
-	      <para>The Differential Revision cannot be added here,
-		however it must be in the svn commit message.</para>
-	    </callout>
-	  </calloutlist>
+	  <callout arearefs="phabricator-subscribers">
+	    <para>Subscribers may be individuals, project groups,
+	      and mailing lists.</para>
+	  </callout>
+
+	  <callout arearefs="phabricator-diffrev">
+	    <para>The Differential Revision cannot be added here,
+	      however it must be in the svn commit message.</para>
+	  </callout>
+	</calloutlist>
 	</step>
 
 	<step>
@@ -3117,6 +3117,34 @@ Subscribers:<co xml:id="phabricator-subs
 	</procedure>
       </sect3>
     </sect2>
+
+    <sect2 xml:id="phabricator-create-revision-web">
+      <title>Create a Revision via Web Interface</title>
+
+      <para>Revisions can be created without having
+	<application>arc</application> installed by uploading a patch
+	via the web interface.  Patches can be created by
+	<application>diff</application>,
+	<application>svn</application>,
+	<application>git</application>
+	or other tools.</para>
+
+      <para>To make reviewing changes easier, always include as much
+	context as possible with a diff.  Phabricator will
+	automatically reduce the context in the default display and
+	when sending emails, but it allows the full context to be
+	displayed on demand in the web interface.</para>
+
+      <para>To create a full diff, use one of the following
+	commands:</para>
+
+      <example>
+	<screen>&prompt.root; <userinput>git diff -U999999 other-branch</userinput></screen>
+
+	<screen>&prompt.root; <userinput>svn diff --diff-cmd=diff -x -U999999</userinput></screen>
+      </example>
+
+    </sect2>
   </sect1>
 
   <sect1 xml:id="people">


More information about the svn-doc-user mailing list