# Fixes for documentation in source. Which branch to start?

- Thread: https://externals.io/message/68139
- Original archive: https://news-web.php.net/php.internals/68139
- Started by Yasuo Ohgaki on 2013-07-18T03:55:00+00:00
- Messages: 10
- Reply by email to internals@lists.php.net
- More for agents: search with https://externals.io/search.md?q={query} · JSON API at https://externals.io/api · documentation at https://externals.io/llms.txt

---

## #68139 — Yasuo Ohgaki — 2013-07-18T03:55:00+00:00

URL: https://externals.io/message/68139#68139

Hi all,

Take a look at this PR

https://github.com/php/php-src/pull/351.diff

The documentation in php.ini-* is broken, where should we
fix these kind of error?

From 5.3 branch or 5.4 branch?

Thank you.

--
Yasuo Ohgaki
yohgaki@ohgaki.net

---

## #68141 — Sherif Ramadan — 2013-07-18T04:19:27+00:00

URL: https://externals.io/message/68139#68141 · In reply to: #68139

> Hi all,
>
> Take a look at this PR
>
> https://github.com/php/php-src/pull/351.diff
>
> The documentation in php.ini-* is broken, where should we
> fix these kind of error?
>
> From 5.3 branch or 5.4 branch?
>


5.3 is security fixes only.

---

## #68142 — Yasuo Ohgaki — 2013-07-18T05:26:05+00:00

URL: https://externals.io/message/68139#68142 · In reply to: #68141

Hi Sherif,

2013/7/18 Sherif Ramadan <theanomaly.is@gmail.com>

> 5.3 is security fixes only.


It may be good idea keep basic principle for docs, too.
I've committed from PHP 5.4.

Regards,

--
Yasuo Ohgaki
yohgaki@ohgaki.net

---

## #68144 — Pierre Joye — 2013-07-18T05:37:55+00:00

URL: https://externals.io/message/68139#68144 · In reply to: #68141

> 
>
> > […]
>
>
> 5.3 is security fixes only.

Well, I don't see a good enough reason not to commit documentation to
5.3 as well

--
Pierre

@pierrejoye | http://www.libgd.org

---

## #68145 — Sherif Ramadan — 2013-07-18T06:53:38+00:00

URL: https://externals.io/message/68139#68145 · In reply to: #68144

> On Thu, Jul 18, 2013 at 6:19 AM, Sherif Ramadan <theanomaly.is@gmail.com>
> wrote:
> > […]
> wrote:
> > […]
>
> Well, I don't see a good enough reason not to commit documentation to
> 5.3 as well
>

I suppose you're right since it's not source code, but it remains dubious
that this counts as documentation. If we want to add documentation notes
for this it should go in the manual where we document everything. Not that
I'm the arbiter of what goes in 5.3.


>
> --
> Pierre
>
> @pierrejoye | http://www.libgd.org

---

## #68146 — Pierre Joye — 2013-07-18T07:18:26+00:00

URL: https://externals.io/message/68139#68146 · In reply to: #68145

>
>
>
> 
> > […]
>
>
> I suppose you're right since it's not source code, but it remains dubious
> that this counts as documentation. If we want to add documentation notes for
> this it should go in the manual where we document everything. Not that I'm
> the arbiter of what goes in 5.3.

You are welcome to add more (internals or general) documentations to
the manual. But the sources have always contained documentation, the
more the better :)


--
Pierre

@pierrejoye |  http://www.libgd.org

---

## #68147 — Lester Caine — 2013-07-18T07:24:18+00:00

URL: https://externals.io/message/68139#68147 · In reply to: #68145

Sherif Ramadan wrote:
> > […]
> I suppose you're right since it's not source code, but it remains dubious
> that this counts as documentation. If we want to add documentation notes
> for this it should go in the manual where we document everything. Not that
> I'm the arbiter of what goes in 5.3.

It's a bit chicken and egg when it comes to the sample .ini files? Nobody should 
be installing a new server from 5.3, just perhaps rebuilding an existing one 
where their ini files should already exist? And if they are trying to replicate 
an older setup they already have the faulty details. In any case any changes 
would not be released until there was a security fix that warrants one?

-- 
Lester Caine - G8HFL
-----------------------------
Contact - http://lsces.co.uk/wiki/?page=contact
L.S.Caine Electronic Services - http://lsces.co.uk
EnquirySolve - http://enquirysolve.com/
Model Engineers Digital Workshop - http://medw.co.uk
Rainbow Digital Media - http://rainbowdigitalmedia.co.uk

---

## #68158 — johannes@schlueters.de — 2013-07-18T11:45:47+00:00

URL: https://externals.io/message/68139#68158 · In reply to: #68144

> > […]
> 
> Well, I don't see a good enough reason not to commit documentation to
> 5.3 as well

There is a good reason: Having clean diffs between releases.

johannes

---

## #68159 — Pierre Joye — 2013-07-18T13:43:15+00:00

URL: https://externals.io/message/68139#68159 · In reply to: #68158

>
> 
> > […]
>
> There is a good reason: Having clean diffs between releases.

Any non archaic tool will let you sort them out easily.

---

## #68172 — Yasuo Ohgaki — 2013-07-18T22:38:57+00:00

URL: https://externals.io/message/68139#68172 · In reply to: #68159

Hi Pierre,

2013/7/18 Pierre Joye <pierre.php@gmail.com>

> On Jul 18, 2013 1:46 PM, "Johannes Schlüter" <johannes@schlueters.de>
> wrote:
> > […]
>
> Any non archaic tool will let you sort them out easily.
>
I agree.
It's very annoying.
So should we commit docs/comment fix to PHP-5.3 branch until
the end of security patch support?

Regards,

--
Yasuo Ohgaki
yohgaki@ohgaki.net
