doc:scratchpad:howto:faq

So, How exactly do I get the source files for the PHP Manual?

Simple. The PHP Project uses CVS to manage its sources, so to retrieve the sources for the PHP Manual you will checkout (download) these sources from CVS. An anonymous CVS user named cvsread exists (password: phpfi) that anybody in the world may use to make checkouts. For example:

$ cvs -d :pserver:cvsread@cvs.php.net:/repository login
$ cvs -d :pserver:cvsread@cvs.php.net:/repository checkout phpdoc

The above assumes you have CVS installed. Odds are if you're using Linux or Mac that this is already installed, but Windows users aren't so lucky (or unlucky, depending on your feelings towards CVS!) The simplest method for Windows users is TortoiseCVS, see the FAQ for that.

There will now exist a directory named phpdoc that houses all sources files for the PHP Manual.

I use Windows, and heard something about TortoirseCVS... should I use it?

Sure, it's simple and offers a friendly GUI so if you're into that then go for it! And besides, it also installs the cvs command so it may be used in your Terminal too. The steps include:

  • Install TortoirseCVS
  • Open a new explorer window and go to the folder you wish to do a checkout in (store CVS files)
  • Right click anywhere in the blank area to spawn the context menu, select “CVS Checkout”
  • A new window will popup and ask for details about the checkout; these values will be remembered so will be entered just once
  • Enter the following:
    • CVSROOT: “:pserver:cvsread@cvs.php.net:/repository”
    • Module field: “phpdoc”
    • Press OK to begin the checkout. If you're prompted to enter a password while checking out, then type in “phpfi” and OK
  • When the checkout is complete, then it should have created a directory called “phpdoc” where the english php documentation source tree will be

I was told to create a patch, how do I do that?

New Files
Current Files

How do I know if my changes are good and valid?

  • Whitespace
  • Read diff
  • php configure.php
  • Describe when editing manual.xml.in is needed
  • PhD

Is there an online editor?

  • Yes and No
doc/scratchpad/howto/faq.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1