Všetko  Arabic Brazilian Portuguese Bulgarian Chinese (Simplified) Chinese (Hong Kong Cantonese) Chinese (Traditional) Czech Danish Dutch Finnish French German Greek Hebrew Hungarian Italian Japanese Korean Norwegian Persian Polish Portuguese Romanian Russian Serbian Slovak Slovenian Spanish Swedish Turkish English

Checking Out a SVN Module

Now it's time to checkout the phpdoc module first. Incidentally, a module is a collection of source directories and files. Usually it's simply a directory tree in the SVN repository.

cd to a directory you wish to store the phpdoc tree under. Wherever you decide to put it, a phpdoc directory will be created there. Issue the following command:

$ svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en phpdoc
     

Note: The directory named phpdoc

The above command does create a directory named phpdoc, however, the name can be anything you wish. phpdoc/modules/doc-en is an SVN external that essentially checks out the English sources along with the associated tools found in doc-base. Then, the last segment in the command (phpdoc) is the local directory name on your hard drive.

We refer to the directory as phpdoc to keep things simple, and default to SVN externals to also keep things simple. It actually checks out en/trunk/ from SVN, as opposed to a branch or tag, and renames it to simply en/.

After some status information about the checkout scrolls by, you should have a full working copy of the phpdoc module. Be prepared to wait for a long time for this to complete, as the module contains many small files.

Note:

You are not completely free to decide where this phpdoc directory should be. See the Tools and Setup Instructions section for more precise information about whether the place of this phpdoc directory is restricted on your system or not.

If you would like to work with a translation group, checking out the sources is a little different. Again, using SVN externals we simply change phpdoc-en to phpdoc-{langcode} where {langcode} is for the desired language. These translations include English so there is no need to checkout both seperately. For example, for Italian:

$ svn checkout https://svn.php.net/repository/phpdoc/modules/doc-it phpdoc-it
     

Substitute the "it" part with your language code. You can check out any number of translations as you need, and you need not check out any translation if you would not like to work with it. To work with the English files, no translation module needs to be checked out.

Note: Note: Brazilian Portuguese

The format of this translations name differs from the rest in that it's called pt_BR.

You also have the ability of checking out the complete build infrastructure and all the languages. You can do this with:

$ svn checkout https://svn.php.net/repository/phpdoc/modules/doc-all phpdoc-all
     
The result of this command will be a phpdoc-all folder with all the stuff you requested.