hi,
i just noticed that for some reason the chapter on pike internals which can be found in an old version of the pike manual is not there anymore in the current version:
http://fredrik.hubbe.net/pike/tutorial/tutorial_split_17.html
i think there are more useful sections in that old manual that are not in the current one. i noticed this one because of people repeatedly looking for documentation on the master, and that seems to be the only place where that documentation seems to still exist.
anyone know why this has been dropped? intentional (because it's maybe outdated)? or by accident (lost during restructuring of sections)? or is it simply waiting to be converted to the new doc format?
greetings, martin.
ah, thank you. i think it has been waiting so long that a lot of people are not even aware anymore that it stills exists.
where is the latest version of that documentation? is it in cvs along with the current pike code (and just not being exported because of the wrong format?) or does it have to be (re)added to cvs?
can you exemplify how the format changed and describe what kind of effort is involved to make that change?
greetings, martin.
I don't think it is in CVS.
The non-module reference parts of the documentation is in refdoc/chapters in a fairly simple XML format.
None of the old documentation has been added to the refdoc folder without at least some sort of proofreading. The reasoning has been that no documentation is better than false documentation. But perhaps not.
ok, so the conversion is not the problem, but the proofreading is? if that is the case then i'd suggest to make the conversion without proofreading but add a warning that these parts have not been proofread.
that way we are sure that the docs are at least available and won't get lost. with the warning, people will be more encuraged to report errors (as opposed to only be frustrated that things don't work as documented)
the proofreading can then happen over time as people ask questions about specific sections.
btw the old tutorial seems to be here: http://pike.ida.liu.se/development/cvs/browse.xml?dir=7.2/tutorial&modul... that directory is empty in 7.4
greetings, martin.
Hello Martin and all...
Le 4 janv. 07 à 23:31, Martin Baehr a écrit :
ok, so the conversion is not the problem, but the proofreading is? if that is the case then i'd suggest to make the conversion without proofreading but add a warning that these parts have not been proofread.
that way we are sure that the docs are at least available and won't get lost. with the warning, people will be more encuraged to report errors (as opposed to only be frustrated that things don't work as documented)
the proofreading can then happen over time as people ask questions about specific sections.
btw the old tutorial seems to be here: http://pike.ida.liu.se/development/cvs/browse.xml?dir=7.2/ tutorial&module=Pike that directory is empty in 7.4
I still get old version on line : http://pike.oav.net/7.1/ tutorial_frame.html
/Xavier
pike-devel@lists.lysator.liu.se
-
Martin Baehr -
Martin Bähr
-
Martin Nilsson (Opera Mini - AFK!) ＠ Pike (-) developers forum -
Xavier Beaudouin