doc:scratchpad:howto

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
doc:scratchpad:howto [2008/12/19 07:04] – Added TortoiseCVS tutorial kalledoc:scratchpad:howto [2009/08/04 11:31] – Fix CVS mentions mrook
Line 1: Line 1:
 ===== Quick guide for improving the existing PHP documentation ===== ===== Quick guide for improving the existing PHP documentation =====
- 
 ==== Getting setup ==== ==== Getting setup ====
  
Line 6: Line 5:
  
 == Source files of the PHP Manual == == Source files of the PHP Manual ==
-They are stored in a CVS module named 'phpdoc'. See also the [[http://php.net/anoncvs|generic generic php.net CVS instructions]]. And these examples use the cvs command but other methods exist, like [[http://www.tortoisecvs.org/|TortoisCVS]] for Windows users. +They are stored in a SVN module named 'phpdoc'. See also the [[http://www.php.net/svn.php|generic generic php.net SVN instructions]]. And these examples use the svn command but other methods exist, like [[http://www.tortoisesvn.net/|TortoiseSVN]] for Windows users.
-Assuming no CVS account (Password for user //cvsread// is //phpfi//):+
 <code> <code>
-$ cvs -d :pserver:cvsread@cvs.php.net:/repository login +$ svn checkout http://svn.php.net/repository/phpdoc
-$ cvs -d :pserver:cvsread@cvs.php.net:/repository checkout phpdoc+
 </code> </code>
-The key information: Server: cvs.php.net User: cvsread Pass: phpfi CVS Module: phpdoc 
  
-== Using TortoirseCVS on Windows to do a checkout == +== Using TortoiseSVN on Windows to do a checkout == 
-  * First off, download and install TortoirseCVS from its website: [[http://www.tortoisecvs.org/]]+  * First off, download and install TortoiseSVN from its website: [[http://tortoisesvn.net/]]
   * Open a new explorer window and go to the folder you wish to do a checkout in   * Open a new explorer window and go to the folder you wish to do a checkout in
-  * Right click anywhere in the blank area to spawn the context menu, select "CVS Checkout"+  * Right click anywhere in the blank area to spawn the context menu, select "SVN Checkout..."
   * A new window will popup asking for details about the checkout, these values will be remembered, so you will not need to enter them again   * A new window will popup asking for details about the checkout, these values will be remembered, so you will not need to enter them again
-  * Enter the following CVSROOT: ":pserver:cvsread@cvs.php.net:/repository" and enter "phpdoc" in the module field, then OK to being the checkout. If you're prompted to enter a password while checking out, then type in "phpfi" and OK +  * Enter the following URL: "http://svn.php.net/repository/phpdoc", then 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+  * When the checkout is complete, then it should have created a directory called "phpdoc" where the php documentation source tree will be 
  
  
Line 63: Line 60:
 There you'll find several files: There you'll find several files:
  
-  * //book.xml// (Acts as the container for the extension and contains the preface)+  * //book.xml// (Acts as the container for the extension and contains the preface. Other files (like //examples.xml// are included from here)
   * //setup.xml// (Includes setup, install and configuration documentaiton)   * //setup.xml// (Includes setup, install and configuration documentaiton)
   * //constants.xml// (Lists all constants the extension declares, if any)   * //constants.xml// (Lists all constants the extension declares, if any)
   * //configure.xml// (Usually this information is in setup.xml, but if the file exists it is magically included into setup.xml)   * //configure.xml// (Usually this information is in setup.xml, but if the file exists it is magically included into setup.xml)
 +  * //examples.xml// (Various examples)
 +  * //foo.xml// (Example, foo can be anything specific to a topic. Just be sure to include via //book.xml//)
  
 A procedural extension (like SVN) also has: A procedural extension (like SVN) also has:
Line 79: Line 78:
  
   * Note: "//classname//" is the lowercased name of the class, not a literal file or directory name.   * Note: "//classname//" is the lowercased name of the class, not a literal file or directory name.
- 
 ==== Editing existing documentation ==== ==== Editing existing documentation ====
 Simply open the files and edit them. Remember to follow the "coding standard" described in the documentation howto. And after it validates, commit. Simply open the files and edit them. Remember to follow the "coding standard" described in the documentation howto. And after it validates, commit.
 <code> <code>
-$ vim phpdoc/en/reference/strings/strlen.xml+$ vim phpdoc/en/trunk/reference/strings/strlen.xml
 $ php configure.php $ php configure.php
-$ cvs commit phpdoc/en/reference/strings/strlen.xml -m "Added SeeAlso strpos()"+$ svn commit -m "Added SeeAlso strpos()" phpdoc/en/trunk/reference/strings/strlen.xml
 </code> </code>
  
Line 125: Line 123:
  
 If everything is looking good, its time to post the changes. If everything is looking good, its time to post the changes.
- 
 ==== Committing the changes ==== ==== Committing the changes ====
  
Line 133: Line 130:
  
 <code> <code>
-  $ cvs diff -u > changes.patch+  $ svn diff > changes.patch
 </code> </code>
  
Line 144: Line 141:
 == Committing patches == == Committing patches ==
  
-If you have CVS karma then there is no need to create patches... just commit!  +If you have SVN karma then there is no need to create patches... just commit! 
- +
doc/scratchpad/howto.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1

Page Tools