From 280e7d5e17ff1aef4d5cdd9992568d9f6ac1314d Mon Sep 17 00:00:00 2001 From: guilhermeblanco Date: Tue, 19 Feb 2008 02:41:37 +0000 Subject: [PATCH] Updates in Getting Started manual chapter (fixes #794) --- .../docs/en/getting-started/installation.txt | 50 ++++++++++++++++--- .../getting-started/starting-new-project.txt | 2 +- .../working-with-existing-databases.txt | 2 +- 3 files changed, 45 insertions(+), 9 deletions(-) diff --git a/manual/docs/en/getting-started/installation.txt b/manual/docs/en/getting-started/installation.txt index a3da88ad0..c3f34d374 100644 --- a/manual/docs/en/getting-started/installation.txt +++ b/manual/docs/en/getting-started/installation.txt @@ -1,17 +1,53 @@ -The installation of doctrine is very easy. Just get the latest revision of -Doctrine from http://svn.phpdoctrine.org/trunk. +There are currently two different methods to install Doctrine. -You need a SVN (Subversion) client for downloading Doctrine. +* SVN (subversion) +* SVN externals -In order to check out Doctrine in the current directory using the **svn** command line tool use the following code: +It is recommended to download Doctrine via SVN (subversion), because in this case updating is easy. +If your project is already under version control with SVN, you should choose SVN externals. + + ++++ SVN + +The installation of doctrine via SVN is very easy. Just get the latest revision of Doctrine from http://svn.phpdoctrine.org/trunk. + +In order to check out Doctrine in the current directory using the **svn** command line tool use the following code: -svn co http://svn.phpdoctrine.org/trunk . +svn co http://svn.phpdoctrine.org/trunk . -If you do not have a SVN client, chose one from the list below. Find the -**Checkout** option and enter http://svn.phpdoctrine.org/trunk in the **path** or **repository url** parameter. There is no need for a username or password to check out Doctrine. +If you do not have a SVN client, chose one from the list below. Find the **Checkout** option and enter svn.phpdoctrine.org/trunk in the **path** or **repository url** parameter. There is no need for a username or password to check out Doctrine. * [http://tortoisesvn.tigris.org/ TortoiseSVN] a Windows application that integrates into Windows Explorer * [http://www.apple.com/downloads/macosx/development_tools/svnx.html svnx] a Mac OS X GUI svn application * Eclipse has SVN integration through the [http://subclipse.tigris.org/ subeclipse] plugin + +You can update to the latest version with + + +svn update + + +in your doctrine directory. + + ++++ SVN externals + +If your project is under version control with SVN, you should set up doctrine via svn externals. You can do this with the **svn** command line tool: + + +svn pe svn:externals /path/to/project + + +You have to put the following line in the editor and save the changes. + + +doctrine http://svn.phpdoctrine.org/trunk + + +Afterwards you can download doctrine with + + +svn update + diff --git a/manual/docs/en/getting-started/starting-new-project.txt b/manual/docs/en/getting-started/starting-new-project.txt index 759fbce30..4f7f064a7 100644 --- a/manual/docs/en/getting-started/starting-new-project.txt +++ b/manual/docs/en/getting-started/starting-new-project.txt @@ -25,7 +25,7 @@ For exporting the user class into database we need a simple build script: //require the base Doctrine class -require_once('lib/Doctrine.php'); +require_once('path-to-doctrine/lib/Doctrine.php'); //register the autoloader spl_autoload_register(array('Doctrine', 'autoload')); diff --git a/manual/docs/en/getting-started/working-with-existing-databases.txt b/manual/docs/en/getting-started/working-with-existing-databases.txt index 19bf40788..2f25ecfee 100644 --- a/manual/docs/en/getting-started/working-with-existing-databases.txt +++ b/manual/docs/en/getting-started/working-with-existing-databases.txt @@ -25,7 +25,7 @@ CREATE TABLE file ( Now we would like to convert it into Doctrine record class. It can be achieved easily with the following code snippet: -require_once('lib/Doctrine.php'); +require_once('path-to-doctrine/lib/Doctrine.php'); spl_autoload_register(array('Doctrine', 'autoload')); Doctrine_Manager::connection('mysql://root:dc34@localhost/test');