Skip to content

Commit d83871e

Browse files
authored
docs: replace obsolete SVN references with Git workflows (#231)
1 parent 7366bc9 commit d83871e

File tree

3 files changed

+30
-34
lines changed

3 files changed

+30
-34
lines changed

docs/phd-guide/phd-guide.xml

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ install ok: channel://doc.php.net/PhD-1.0.1
9797
install ok: channel://doc.php.net/PhD_Generic-1.0.1
9898
install ok: channel://doc.php.net/PhD_PHP-1.0.1
9999
install ok: channel://doc.php.net/PhD_PEAR-1.0.1
100-
bjori@jessica:/usr/src/php/svn/phd/trunk$
101100
101+
$ cd phd
102102
$ phd --version
103-
PhD Version: phd-from-svn
103+
PhD Version: phd-from-git
104104
PHP Version: 5.3.3-dev
105105
Copyright(c) 2007-2010 The PHP Documentation Group
106106
]]>
@@ -113,20 +113,22 @@ Copyright(c) 2007-2010 The PHP Documentation Group
113113

114114
<chapter xml:id="using-phd">
115115
<title>Using PhD to render documentation</title>
116-
116+
<note>
117+
<para>
118+
Earlier versions of the PHP documentation infrastructure used Subversion (SVN).
119+
All PHP documentation repositories are now maintained using Git.
120+
</para>
121+
</note>
117122
<section xml:id="render-phpdoc">
118123
<title>Rendering the PHP Documentation Sources</title>
119124

120125
<sidebar>
121126
<title>Getting the PHP Documentation Sources</title>
122-
123-
<para>To get the PHP documentation sources, simply <link
124-
xlink:href="http://wiki.php.net/doc/scratchpad/howto/checkout">check them out from SVN</link>
125-
with the following command.</para>
126-
127+
<para>To get the PHP documentation sources, simply clone them from the
128+
official Git repository with the following command.</para>
127129
<screen>
128130
<![CDATA[
129-
$ svn co http://svn.php.net/repository/phpdoc/modules/doc-en phpdoc
131+
$ git clone https://github.com/php/doc-en.git phpdoc
130132
... output
131133
]]>
132134
</screen>
@@ -142,7 +144,7 @@ $ svn co http://svn.php.net/repository/phpdoc/modules/doc-en phpdoc
142144
</sidebar>
143145

144146
<para>To quickly become familiar with using PhD, you can download the
145-
PHP documentation sources and render those.Running PhD to render the
147+
PHP documentation sources and render those. Running PhD to render the
146148
docs is surprisingly simple, so we'll start with that.</para>
147149

148150
<screen>
@@ -300,8 +302,8 @@ Supported packages:
300302

301303
<screen>
302304
<![CDATA[
303-
$ svn checkout http://svn.php.net:/repository/phd/trunk/docs/phd-guide
304-
U phd/docs/phd-guide/phd-guide.xml
305+
$ git clone https://github.com/php/phd.git
306+
$ cd phd/docs/phd-guide
305307
]]>
306308
</screen>
307309

@@ -677,12 +679,6 @@ $ pear install mediawiki/geshi]]></screen>
677679
<para>Some other articles for further reading. Latest are on top.</para>
678680

679681
<itemizedlist>
680-
<listitem>
681-
<para><link
682-
xlink:href="http://elizabethmariesmith.com/2009/02/setting-up-phd-on-windows/">Setting
683-
up PhD on Windows</link> by Elizabeth Marie Smith (PhD 0.4.5)</para>
684-
</listitem>
685-
686682
<listitem>
687683
<para><link
688684
xlink:href="http://bjori.blogspot.com/2007/10/phd-php-based-docbook-renderer-rc1.html">PhD

phpdotnet/phd/Package/PHP/HOWTO.GENERATE_CHM

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ All Rights Reserved.
44

55
Warning: you'll need Windows to build CHM files.
66

7-
First, you will need to get the last SVN version of the PhD renderer from the repository:
8-
svn checkout http://svn.php.net/repository/phd/trunk phd
7+
First, you will need to get the latest version of the PhD renderer from the repository:
8+
git clone https://github.com/php/phd.git phd
99

1010
Then, you need to get the documentation:
11-
svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en
11+
git clone https://github.com/php/doc-en.git doc-en
1212

1313
If you want to render a translated documentation instead:
14-
svn checkout http://svn.php.net/repository/phpdoc/modules/doc-{lang}
15-
where {lang} is the ISO 639-1 Code of the desired language.
14+
git clone https://github.com/php/doc-{lang}.git
15+
where {lang} is the ISO 639-1 language code (optionally followed by a country code).
1616
(see http://www.sil.org/iso639-3/codes.asp for a list of codes)
1717
e.g. 'pt' for Portuguese, or pt_BR for Brazillian Portuguese.
1818
The example above would change to:
19-
svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt
19+
git clone https://github.com/php/doc-pt.git
2020
or
21-
svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt_BR
21+
git clone https://github.com/php/doc-pt_BR.git
2222

2323
To render the documentation:
2424
#1) cd {PHPDOC_PATH}
@@ -35,7 +35,7 @@ Finally, to compile the CHM sources:
3535
#3) In the "File" menu, click on "Compile...", then the "Compile" button.
3636
#4) After the compilation process, you should see the message "Created {RENDER_PATH}\chm\php_manual_{lang}.chm". You can quit HTML Help Workshop.
3737

38-
Done ! The compiled CHM file is located on "{RENDER_PATH}\chm\php_manual_{lang}.chm".
38+
Done! The compiled CHM file is located at "{RENDER_PATH}\chm\php_manual_{lang}.chm".
3939

4040
Please read the README file for further information.
4141

phpdotnet/phd/Package/PHP/README

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
Rendering the documentations for the first time:
22
WINDOWS:
33
#1) cd c:\
4-
#2) svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en
4+
#2) git clone https://github.com/php/doc-en.git
55
#3) cd doc-en\doc-base
66
#4) php configure.php
7-
#5) phd --docbook c:\doc-en\doc-base\.manual.xml
7+
#5) phd --docbook c:\doc-en\doc-base\.manual.xml
88

99
*NIX:
1010
#1) cd ~
11-
#2) svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en
11+
#2) git clone https://github.com/php/doc-en.git
1212
#3) cd doc-en/doc-base
1313
#4) php configure.php
14-
#5) phd --docbook ~/doc-en/doc-base/.manual.xml
14+
#5) phd --docbook ~/doc-en/doc-base/.manual.xml
1515

1616

1717
This will create
@@ -27,11 +27,11 @@ Now edit the XML files as you wish in the doc-en/en directory.
2727
To build the documentation again follow the instructions above, skipping step#2.
2828

2929
NOTE: To work on translations, you should replace the 'en' in all
30-
of the above examples with the appropriate ISO 639-1 Code of the desired language.
30+
of the above examples with the appropriate ISO 639-1 language code (optionally followed by a country code).
3131
(see http://www.sil.org/iso639-3/codes.asp for a list of codes)
32-
e.g. 'pt' for Portuguese, or pt_BR for Brazillian Portuguese. Step two in the
32+
e.g. 'pt' for Portuguese, or pt_BR for Brazilian Portuguese. Step two in the
3333
example above would change to:
34-
svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt
34+
git clone https://github.com/php/doc-pt.git
3535
or
36-
svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt_BR
36+
git clone https://github.com/php/doc-pt_BR.git
3737
The XML files to edit will be in doc-pt/pt or doc-pt_BR/pt_BR directories.

0 commit comments

Comments
 (0)