php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Bug #80946 Doc build instructions incomplete
Submitted: 2021-04-09 16:03 UTC Modified: 2021-04-12 12:19 UTC
From: php-bugs at allenjb dot me dot uk Assigned:
Status: Verified Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Developer Edit
 [2021-04-09 16:03 UTC] php-bugs at allenjb dot me dot uk 
Description:
------------
The same or very similar instructions appear in 3 places I found:
https://github.com/php/doc-base (README.md)
http://doc.php.net/tutorial/local-setup.php
https://wiki.php.net/doc/phd

This is the actual sequence of commands I ended up running:
mkdir phpdoc
cd phpdoc
git clone git@github.com:php/doc-en.git
git clone git@github.com:php/doc-base.git
git clone https://github.com/php/phd.git
php phd/render.php --help
php doc-base/configure.php
cd doc-en
php ../doc-base/configure.php

Both times I ran doc-base/configure.php resulted in a "No language directory found" error.

After scanning configure.php to see what it was looking for, to fix the issue I created 'en' in the phpdoc directory, then ran doc-base/configure.php from there.

The instructions should be updated with the missing step to create the language directory.

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2021-04-09 16:12 UTC] cmb@php.net
-Status: Open +Status: Verified -Assigned To: +Assigned To: cmb
 [2021-04-09 16:12 UTC] cmb@php.net 
For https://github.com/php/doc-base,

    git clone git@github.com:php/doc-en.git

should actually be

    git clone git@github.com:php/doc-en.git en

After ./configure there should be a file doc-base/.manual.xml
(~40MB) which is the full PHP manual in DocBook format.  This file
can then be fed to PhD for rendering.
 [2021-04-12 12:19 UTC] cmb@php.net
-Package: Doc Build problem +Package: Documentation problem -Assigned To: cmb +Assigned To:
 [2021-04-12 12:19 UTC] cmb@php.net 
I've just fixed the description in doc-base\README.md[1].  Not
sure what to do with the other places; probably a good idea to
unify and link to a canonical source.

[1] <https://github.com/php/doc-base/commit/fb807d73f70fd46026f447a8c36da9ed54d1439b>
 [2021-04-17 10:08 UTC] php-bugs at allenjb dot me dot uk 
Not sure if this should maybe be a separate issue, but I just found http://doc.php.net/phd/docs/ via a google search, which refers to installing phd from the (as far as I can tell) no longer present svn repo
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved. 		Last updated: Sat Dec 21 13:01:31 2024 UTC