@@ -13,7 +13,7 @@ https://www.php.net/docs.php
13
13
# How to write phpdoc files
14
14
15
15
If you are interested in information about how to
16
- set up the tools needed, how to work with git and
16
+ set up the tools needed, how to work with Git and
17
17
DocBook on Linux or Windows, or what conventions you
18
18
should follow when writing phpdoc files, please refer
19
19
to the PHP Documentation HOWTO.
@@ -36,9 +36,9 @@ https://wiki.php.net/doc/phd
36
36
### Source checkout
37
37
38
38
For a more general git-workflow see [ the Wiki] ( https://wiki.php.net/vcs/gitworkflow#reviewing_and_closing_pull_requests ) .
39
- Make sure to upload your SSH- key to your account at people .php.net
39
+ Make sure to upload your SSH public key to your account at master .php.net
40
40
41
- Check out the source
41
+ Check out the sources:
42
42
43
43
``` bash
44
44
mkdir phpdoc
50
50
51
51
Change ` your-language-of-choice ` if you would like to check out a different language.
52
52
53
- Where ` en/ ` contains the DocBook source files, and ` doc-base ` contains tools
53
+ The ` en ` folder contains the English DocBook source files, and ` doc-base ` contains tools
54
54
and resources used in all languages.
55
55
56
56
### Edits
@@ -60,15 +60,14 @@ and resources used in all languages.
60
60
``` bash
61
61
git diff path/to/file.xml
62
62
```
63
-
64
63
* Make sure no errors are present, so at the command line in your phpdoc source directory run:
65
64
``` bash
66
- php doc-base/ configure.php
65
+ php configure.php
67
66
```
68
- * If you are translating, remember to add the full hash of the english base- file that you are translating
69
- from, to the files ` EN-Revision ` - comment
67
+ * If you are translating, remember to add the full Git commit hash of the English file that you are translating
68
+ from, to the file's ` EN-Revision ` comment.
70
69
71
- ** Always run ` php configure.php ` before commit!**
70
+ ** Always run ` php doc-base/ configure.php ` before commit!**
72
71
* Commit your changes
73
72
``` bash
74
73
git commit path/to/file.xml
@@ -80,11 +79,11 @@ and concerns.
80
79
81
80
### New functions
82
81
83
- * Copy an existing xml file or use a skeleton from the HOWTO.
82
+ * Copy an existing XML file or use a skeleton from the HOWTO.
84
83
Rename and place it into the appropriate directory.
85
84
* Edit. Be sure no leftover text exists. No tabs either.
86
- * If you are translating, remember to add the full commit- hash of the english
87
- base- file that you are translating from, to the files ` EN-Revision ` - comment.
85
+ * If you are translating, remember to add the full Git commit hash of the English
86
+ file that you are translating from, to the file's ` EN-Revision ` comment.
88
87
* Now test locally before commit by first running
89
88
``` bash
90
89
php configure.php
@@ -98,10 +97,7 @@ and concerns.
98
97
git commit path/to/yourfile.xml
99
98
git push remote your-branch
100
99
```
101
- * Open a PullRequest to the main repository via github
102
-
103
- Note that the version numbers are taken care of elsewhere (don't worry
104
- about them)
100
+ * Open a pull request to the main repository via GitHub
105
101
106
102
### Some popular tags and entities
107
103
@@ -129,7 +125,6 @@ about them)
129
125
&false; <constant>FALSE</constant>
130
126
&php.ini; <filename>php.ini</filename>
131
127
132
- Be sure to check out globals.ent and language-snippets.ent for
133
- more information for entities and urls.
134
-
135
- ---------------------------------------------------------------------------
128
+ Be sure to check out [ global.ent] ( entities/global.ent ) and
129
+ language-snippets.ent (located within each language's repo) for
130
+ more information for entities and URLs.
0 commit comments