[DOC-CVS] [phd] master: docs: replace obsolete SVN references with Git workflows (#231)
[email protected] (Louis-Arnaud via GitHub)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Louis-Arnaud (lacatoire)
Committer: GitHub (web-flow)
Pusher: Girgias
Date: 2026-01-09T02:12:30Z
Commit: https://github.com/php/phd/commit/d83871e6b5644216ba4ea32f188fbeaaf88db6b7
Raw diff: https://github.com/php/phd/commit/d83871e6b5644216ba4ea32f188fbeaaf88db6b7.diff
docs: replace obsolete SVN references with Git workflows (#231)
Changed paths:
M docs/phd-guide/phd-guide.xml
M phpdotnet/phd/Package/PHP/HOWTO.GENERATE_CHM
M phpdotnet/phd/Package/PHP/README
Diff:
diff --git a/docs/phd-guide/phd-guide.xml b/docs/phd-guide/phd-guide.xml
index 833595f6..7390bc77 100644
--- a/docs/phd-guide/phd-guide.xml
+++ b/docs/phd-guide/phd-guide.xml
@@ -97,10 +97,10 @@ install ok: channel://doc.php.net/PhD-1.0.1
install ok: channel://doc.php.net/PhD_Generic-1.0.1
install ok: channel://doc.php.net/PhD_PHP-1.0.1
install ok: channel://doc.php.net/PhD_PEAR-1.0.1
-bjori@jessica:/usr/src/php/svn/phd/trunk$
+$ cd phd
$ phd --version
-PhD Version: phd-from-svn
+PhD Version: phd-from-git
PHP Version: 5.3.3-dev
Copyright(c) 2007-2010 The PHP Documentation Group
]]>
@@ -113,20 +113,22 @@ Copyright(c) 2007-2010 The PHP Documentation Group
<chapter xml:id="using-phd">
<title>Using PhD to render documentation</title>
-
+ <note>
+ <para>
+ Earlier versions of the PHP documentation infrastructure used Subversion (SVN).
+ All PHP documentation repositories are now maintained using Git.
+ </para>
+ </note>
<section xml:id="render-phpdoc">
<title>Rendering the PHP Documentation Sources</title>
<sidebar>
<title>Getting the PHP Documentation Sources</title>
-
- <para>To get the PHP documentation sources, simply <link
- xlink:href="http://wiki.php.net/doc/scratchpad/howto/checkout">check them out from SVN</link>
- with the following command.</para>
-
+ <para>To get the PHP documentation sources, simply clone them from the
+ official Git repository with the following command.</para>
<screen>
<![CDATA[
-$ svn co http://svn.php.net/repository/phpdoc/modules/doc-en phpdoc
+$ git clone https://github.com/php/doc-en.git phpdoc
... output
]]>
</screen>
@@ -142,7 +144,7 @@ $ svn co http://svn.php.net/repository/phpdoc/modules/doc-en phpdoc
</sidebar>
<para>To quickly become familiar with using PhD, you can download the
- PHP documentation sources and render those.Running PhD to render the
+ PHP documentation sources and render those. Running PhD to render the
docs is surprisingly simple, so we'll start with that.</para>
<screen>
@@ -300,8 +302,8 @@ Supported packages:
<screen>
<![CDATA[
-$ svn checkout http://svn.php.net:/repository/phd/trunk/docs/phd-guide
-U phd/docs/phd-guide/phd-guide.xml
+$ git clone https://github.com/php/phd.git
+$ cd phd/docs/phd-guide
]]>
</screen>
@@ -677,12 +679,6 @@ $ pear install mediawiki/geshi]]></screen>
<para>Some other articles for further reading. Latest are on top.</para>
<itemizedlist>
- <listitem>
- <para><link
- xlink:href="http://elizabethmariesmith.com/2009/02/setting-up-phd-on-windows/">Setting
- up PhD on Windows</link> by Elizabeth Marie Smith (PhD 0.4.5)</para>
- </listitem>
-
<listitem>
<para><link
xlink:href="http://bjori.blogspot.com/2007/10/phd-php-based-docbook-renderer-rc1.html">PhD
diff --git a/phpdotnet/phd/Package/PHP/HOWTO.GENERATE_CHM b/phpdotnet/phd/Package/PHP/HOWTO.GENERATE_CHM
index 2db96c86..30c92f78 100644
--- a/phpdotnet/phd/Package/PHP/HOWTO.GENERATE_CHM
+++ b/phpdotnet/phd/Package/PHP/HOWTO.GENERATE_CHM
@@ -4,21 +4,21 @@ All Rights Reserved.
Warning: you'll need Windows to build CHM files.
-First, you will need to get the last SVN version of the PhD renderer from the repository:
- svn checkout http://svn.php.net/repository/phd/trunk phd
+First, you will need to get the latest version of the PhD renderer from the repository:
+ git clone https://github.com/php/phd.git phd
Then, you need to get the documentation:
- svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en
+ git clone https://github.com/php/doc-en.git doc-en
If you want to render a translated documentation instead:
- svn checkout http://svn.php.net/repository/phpdoc/modules/doc-{lang}
-where {lang} is the ISO 639-1 Code of the desired language.
+ git clone https://github.com/php/doc-{lang}.git
+where {lang} is the ISO 639-1 language code (optionally followed by a country code).
(see http://www.sil.org/iso639-3/codes.asp for a list of codes)
e.g. 'pt' for Portuguese, or pt_BR for Brazillian Portuguese.
The example above would change to:
- svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt
+ git clone https://github.com/php/doc-pt.git
or
- svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt_BR
+ git clone https://github.com/php/doc-pt_BR.git
To render the documentation:
#1) cd {PHPDOC_PATH}
@@ -35,7 +35,7 @@ Finally, to compile the CHM sources:
#3) In the "File" menu, click on "Compile...", then the "Compile" button.
#4) After the compilation process, you should see the message "Created {RENDER_PATH}\chm\php_manual_{lang}.chm". You can quit HTML Help Workshop.
-Done ! The compiled CHM file is located on "{RENDER_PATH}\chm\php_manual_{lang}.chm".
+Done! The compiled CHM file is located at "{RENDER_PATH}\chm\php_manual_{lang}.chm".
Please read the README file for further information.
diff --git a/phpdotnet/phd/Package/PHP/README b/phpdotnet/phd/Package/PHP/README
index 581eaa96..e74ea225 100644
--- a/phpdotnet/phd/Package/PHP/README
+++ b/phpdotnet/phd/Package/PHP/README
@@ -1,17 +1,17 @@
Rendering the documentations for the first time:
WINDOWS:
#1) cd c:\
- #2) svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en
+ #2) git clone https://github.com/php/doc-en.git
#3) cd doc-en\doc-base
#4) php configure.php
- #5) phd --docbook c:\doc-en\doc-base\.manual.xml
+ #5) phd --docbook c:\doc-en\doc-base\.manual.xml
*NIX:
#1) cd ~
- #2) svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en
+ #2) git clone https://github.com/php/doc-en.git
#3) cd doc-en/doc-base
#4) php configure.php
- #5) phd --docbook ~/doc-en/doc-base/.manual.xml
+ #5) phd --docbook ~/doc-en/doc-base/.manual.xml
This will create
@@ -27,11 +27,11 @@ Now edit the XML files as you wish in the doc-en/en directory.
To build the documentation again follow the instructions above, skipping step#2.
NOTE: To work on translations, you should replace the 'en' in all
-of the above examples with the appropriate ISO 639-1 Code of the desired language.
+of the above examples with the appropriate ISO 639-1 language code (optionally followed by a country code).
(see http://www.sil.org/iso639-3/codes.asp for a list of codes)
-e.g. 'pt' for Portuguese, or pt_BR for Brazillian Portuguese. Step two in the
+e.g. 'pt' for Portuguese, or pt_BR for Brazilian Portuguese. Step two in the
example above would change to:
- svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt
+ git clone https://github.com/php/doc-pt.git
or
- svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt_BR
+ git clone https://github.com/php/doc-pt_BR.git
The XML files to edit will be in doc-pt/pt or doc-pt_BR/pt_BR directories.