Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 30186 invoked from network); 7 Jun 2010 07:18:40 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 7 Jun 2010 07:18:40 -0000 Received: (qmail 6402 invoked by uid 500); 7 Jun 2010 07:18:40 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 6334 invoked by uid 500); 7 Jun 2010 07:18:40 -0000 Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: "Forrest Developers List" List-Id: Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 6327 invoked by uid 99); 7 Jun 2010 07:18:39 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 07 Jun 2010 07:18:39 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 07 Jun 2010 07:18:36 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 5F1AF23888E8; Mon, 7 Jun 2010 07:18:15 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r952121 - in /forrest/trunk: etc/ site-author/ site-author/content/xdocs/ site-author/content/xdocs/procedures/ site-author/content/xdocs/tools/ tools/forrestbot/ Date: Mon, 07 Jun 2010 07:18:15 -0000 To: svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20100607071815.5F1AF23888E8@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: crossley Date: Mon Jun 7 07:18:14 2010 New Revision: 952121 URL: http://svn.apache.org/viewvc?rev=952121&view=rev Log: Fix docs for: Use plain svn commands rather than JSVN. Issue: FOR-1198 Modified: forrest/trunk/etc/publishing_our_site.txt forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml forrest/trunk/site-author/publish.xml forrest/trunk/tools/forrestbot/forrest.xml Modified: forrest/trunk/etc/publishing_our_site.txt URL: http://svn.apache.org/viewvc/forrest/trunk/etc/publishing_our_site.txt?rev=952121&r1=952120&r2=952121&view=diff ============================================================================== --- forrest/trunk/etc/publishing_our_site.txt (original) +++ forrest/trunk/etc/publishing_our_site.txt Mon Jun 7 07:18:14 2010 @@ -1,15 +1,11 @@ To publish from trunk/site-author/ Do once: -# Create $FORREST_HOME/deploy.svn.settings file. These credentials -# are needed by forrestbot so that it can do your 'svn add' -# and 'svn commit' etc. to the forrest/site/ repository. -# Set its file permissions so that only you can read it. -# The deploy.svn.settings file looks like: +If your "svn username" is different from your local system username +create $FORREST_HOME/deploy.svn.settings file like: - @@ -22,13 +18,13 @@ Do once: ]$ forrest -f publish.xml deploy -Ddeploy.svn.commit-message="my commit message" Now the files are in SVN at forrest/site -Periodically the real website files are automatically updated from there. +Periodically on the server, the website files are automatically updated +from that repository. You do not need to do anything else. For more information, see: http://forrest.apache.org/procedures/How_to_publish_docs.html http://forrest.apache.org/howto-forrestbot-svn.html ----------------------- Note: The first time that you deploy, it will need to do a long svn checkout first. Modified: forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml?rev=952121&r1=952120&r2=952121&view=diff ============================================================================== --- forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml (original) +++ forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml Mon Jun 7 07:18:14 2010 @@ -89,13 +89,13 @@
The deploy.svn.settings file

- As explained in the above document, each committer needs a - deploy.svn.settings file to provide their credentials. + As explained in the above document, + if your "svn username" is different from your local system username + create $FORREST_HOME/deploy.svn.settings file like:

- ]]>
Modified: forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml?rev=952121&r1=952120&r2=952121&view=diff ============================================================================== --- forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml (original) +++ forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml Mon Jun 7 07:18:14 2010 @@ -47,19 +47,6 @@
Updating the site with a local forrestbot

- Do once, create $FORREST_HOME/deploy.svn.settings file. These - credentials are needed by forrestbot so that it can do your 'svn add' - and 'svn commit' etc. to the forrest/site/ repository. The - deploy.svn.settings file looks like: -

- - - - - -]]> - -

Generating and publishing the main docs is very easy using a local forrestbot:

@@ -67,6 +54,11 @@ forrest -f publish.xml build forrest -f publish.xml deploy

+ Note: if your system username is not the same as your "svn username" + then provide a "deploy.svn.settings" file as explained at + $FORREST_HOME/etc/publishing_our_site.txt +

+

This builds the documentation locally then deploys it by committing it to the forrest/site @@ -106,21 +98,7 @@ $FORREST_HOME/tools/ant/bin/ant deploy-d - - - - - - # Make changes to sources, and then test, then commit. - # Best to wait on committing the source changes until - # you have built and reviewed the docs. # Please, please, ensure valid xml docs. Errors will be # reported during the 'build' phase if you don't. @@ -146,10 +124,6 @@ $FORREST_HOME/tools/ant/bin/ant deploy-d ---------------------- Note: The first time that you deploy, it will need to do a long svn checkout first. - - FIXME: That commit message technique does not work. - The second word is treated as an ant target to be called. - Just leave it out and forrestbot will use a default message. ]]>

Modified: forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml?rev=952121&r1=952120&r2=952121&view=diff ============================================================================== --- forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml (original) +++ forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml Mon Jun 7 07:18:14 2010 @@ -513,15 +513,13 @@ deploy.svn.user - SVN username to use when committing changes - - Yes - - - deploy.svn.password - SVN password - - Yes + + SVN username to use when committing changes. + If your "svn username" is not the same as your local system + username, then see explanation below. + + Local system username. + No deploy.svn.url @@ -537,6 +535,18 @@ No +

+ This uses the "svn" executable expected to be present, and its + authorisation mechanism. +

+

+ If your "svn username" is different from your local system username + create $FORREST_HOME/deploy.svn.settings file like: +

+ + + +]]>
deploy.ftp Modified: forrest/trunk/site-author/publish.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/publish.xml?rev=952121&r1=952120&r2=952121&view=diff ============================================================================== --- forrest/trunk/site-author/publish.xml (original) +++ forrest/trunk/site-author/publish.xml Mon Jun 7 07:18:14 2010 @@ -18,10 +18,6 @@ - Modified: forrest/trunk/tools/forrestbot/forrest.xml URL: http://svn.apache.org/viewvc/forrest/trunk/tools/forrestbot/forrest.xml?rev=952121&r1=952120&r2=952121&view=diff ============================================================================== --- forrest/trunk/tools/forrestbot/forrest.xml (original) +++ forrest/trunk/tools/forrestbot/forrest.xml Mon Jun 7 07:18:14 2010 @@ -18,8 +18,6 @@ -