Bug #80946 [NEW]: Doc build instructions incomplete

From: Date: Fri, 09 Apr 2021 16:03:09 +0000
Subject: Bug #80946 [NEW]: Doc build instructions incomplete
Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-18702@lists.php.net to get a copy of this message
From:             php-bugs at allenjb dot me dot uk
Operating system: 
PHP version:      Irrelevant
Package:          Doc Build problem
Bug Type:         Bug
Bug description:Doc build instructions incomplete

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.


-- 
Edit bug report at https://bugs.php.net/bug.php?id=80946&edit=1
-- 
Fix committed:                    https://bugs.php.net/fix.php?id=80946&r=fixed
Fixed in release:                 https://bugs.php.net/fix.php?id=80946&r=alreadyfixed
Need backtrace:                   https://bugs.php.net/fix.php?id=80946&r=needtrace
Need Reproduce Script:            https://bugs.php.net/fix.php?id=80946&r=needscript
Try newer version:                https://bugs.php.net/fix.php?id=80946&r=oldversion
Not developer issue:              https://bugs.php.net/fix.php?id=80946&r=support
Expected behavior:                https://bugs.php.net/fix.php?id=80946&r=notwrong
Not enough info:                  https://bugs.php.net/fix.php?id=80946&r=notenoughinfo
Submitted twice:                  https://bugs.php.net/fix.php?id=80946&r=submittedtwice
register_globals:                 https://bugs.php.net/fix.php?id=80946&r=globals
PHP version support discontinued: https://bugs.php.net/fix.php?id=80946&r=phptooold
Daylight Savings:                 https://bugs.php.net/fix.php?id=80946&r=dst
IIS Stability:                    https://bugs.php.net/fix.php?id=80946&r=isapi
Install GNU Sed:                  https://bugs.php.net/fix.php?id=80946&r=gnused
Floating point limitations:       https://bugs.php.net/fix.php?id=80946&r=float
No Zend Extensions:               https://bugs.php.net/fix.php?id=80946&r=nozend
MySQL Configuration Error:        https://bugs.php.net/fix.php?id=80946&r=mysqlcfg


Thread (4 messages)

« previous php.doc.bugs (#18702) next »