doc:howto:editing
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:howto:editing [2011/04/17 20:03] – fixed phd command (thanks Ulf W) philip | doc:howto:editing [2017/09/22 13:28] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ==== Editing existing documentation ==== | + | This page has been removed, in favor of [[http://doc.php.net/tutorial/editing.php|new guide]] |
- | Simply open the files and edit them. Remember to follow the " | + | |
- | < | + | |
- | $ vim phpdoc/ | + | |
- | $ php configure.php | + | |
- | $ svn commit -m "Added SeeAlso strpos()" | + | |
- | </ | + | |
- | + | ||
- | ==== Adding new documentation ==== | + | |
- | + | ||
- | When adding new functions or methods, there are a couple of options. Either way, the generated (or copied) files will need to be filled out. | + | |
- | + | ||
- | == Option A: Copy skeleton files == | + | |
- | This involves copying the skeleton files into the correct location: | + | |
- | + | ||
- | < | + | |
- | cp / | + | |
- | cp / | + | |
- | </ | + | |
- | + | ||
- | * Note: " | + | |
- | * Note: " | + | |
- | * Note: " | + | |
- | + | ||
- | == Option B: Generating files using docgen == | + | |
- | The docgen script is found within the php documentation (phpdoc/scripts/docgen/) and uses Reflection to generate documentation (DocBook) files. See the [[doc: | + | |
- | + | ||
- | ==== Testing the changes ==== | + | |
- | + | ||
- | Methods and functions are automagically included into the hierarchy so you don't have to " | + | |
- | + | ||
- | < | + | |
- | $ cd phpdoc | + | |
- | $ php configure.php | + | |
- | </ | + | |
- | + | ||
- | When the above outputs something like "All good. Saving .manual.xml... done." then you know it validates. Now its time to optionally check the rendering: | + | |
- | + | ||
- | < | + | |
- | $ phd -d .manual.xml -P PHP -f xhtml | + | |
- | </ | + | |
- | + | ||
- | This will create a " | + | |
- | + | ||
- | If everything is looking good, its time to post the changes. | + | |
- | ==== Committing the changes ==== | + | |
- | + | ||
- | == Creating patches == | + | |
- | + | ||
- | If you edited existing documentation you will have to create a patch. The following will iterate recursively over the directory and push all changes into the changes.patch file: | + | |
- | + | ||
- | < | + | |
- | $ svn diff > changes.patch | + | |
- | </ | + | |
- | + | ||
- | If you added new files you will have to create an archive of the new files you added (tar -cf changes.tar file1.xml file2.xml file3.xml). On Windows you may use an external utility to create an archive such as [[http:// | + | |
- | + | ||
- | Then upload the archive (or patch file) to http somewhere and post the link to phpdoc@lists.php.net including a short summary of what you did. | + | |
- | + | ||
- | And later committing them yourself | + | |
- | + | ||
- | == Committing patches == | + | |
- | + | ||
- | If you have SVN karma then there is no need to create patches... just commit! | + |
doc/howto/editing.1303070612.txt.gz · Last modified: 2017/09/22 13:28 (external edit)