Re: [PHP-DOC] Intro and quick patches
On Sat, Jul 18, 2009 at 13:50, Niel Archerniel.arc...@blueyonder.co.uk wrote: Hi Here are revised patches that use the modules. Thanks, committed. -Hannes
Re: [PHP-DOC] Intro and quick patches
Hi Here are revised patches that use the modules. phd_README.diff Description: Binary data phd_HOWTO.GENERATE_CHM.diff Description: Binary data
Re: [PHP-DOC] Intro and quick patches
On Wed, Jul 15, 2009 at 02:23, Philip Olsonphi...@roshambo.org wrote: This diff brings up a good point for us to discuss. What is the preferred method to check something out from SVN? Most anything we do requires at least two SVN checkouts. A classic example for English: - cd /where/doc/stuff/is/stored - svn co http://svn.php.net/repository/phpdoc/en/trunk phpdoc/en - svn co http://svn.php.net/repository/phpdoc/doc-base/trunk phpdoc/doc-base People have already created these helper modules: http://svn.php.net/repository/phpdoc/modules/ -Hannes
Re: [PHP-DOC] Intro and quick patches
On Wed, Jul 15, 2009 at 02:06, Niel Archern...@chance.now wrote: However the phd installed doesn't appear to be a working version. i.e. there is no phd.bat file created which makes it is unusable on WIndows I'd guess. Hmh. Richard or Kalle, could you verify this? I'm pretty darn sure we use normal PhD installs over the channel on the Windows box to generate the CHM files.. That phd.bat _should_ be there. Niel: Please fix your From: address.. -Hannes
Re: [PHP-DOC] Intro and quick patches
On Jul 15, 2009, at 12:00 AM, Hannes Magnusson wrote: On Wed, Jul 15, 2009 at 02:23, Philip Olsonphi...@roshambo.org wrote: This diff brings up a good point for us to discuss. What is the preferred method to check something out from SVN? Most anything we do requires at least two SVN checkouts. A classic example for English: - cd /where/doc/stuff/is/stored - svn co http://svn.php.net/repository/phpdoc/en/trunk phpdoc/en - svn co http://svn.php.net/repository/phpdoc/doc-base/trunk phpdoc/doc-base People have already created these helper modules: http://svn.php.net/repository/phpdoc/modules/ So in this case the English example changes to: - cd /where/doc/stuff/is/stored - svn co http://svn.php.net/repository/phpdoc/modules/doc-en Everyone feel comfortable with promoting this as our official method? Which then creates: - /where/doc/stuff/is/stored/doc-en/en - /where/doc/stuff/is/stored/doc-en/doc-base Seems okay. Each translation includes the above plus the language directory. In IRC we discussed a few potential svn:externals gotchas including (KSChan also mentioned these): - They must be manually updated - like when new modules are created or changed. Although, we rarely add languages so this is a bigger worry for other parts of php.net, like pecl - We can't do the following (and no error is given): --- cd /where/doc/stuff/is/stored/doc-en/ --- svn diff --- svn commit -m 'changes I made to both doc-base/ and en/' Not show stoppers here but worth noting and documenting. It's rare people will want to do the latter, except for let's say adding an URL (as the entity lives in doc-base) but then again the following does work: --- cd /where/doc/stuff/is/stored/doc-en/ --- svn diff en doc-base --- svn commit en doc-base -m 'changes I made to both doc-base/ and en/' One thing we shouldn't do anyways is for example commit to both en/ and ja/ in one commit, or phpdoc and php-src... Regards, Philip
Re: [PHP-DOC] Intro and quick patches
2009/7/15 Hannes Magnusson hannes.magnus...@gmail.com: On Wed, Jul 15, 2009 at 02:06, Niel Archern...@chance.now wrote: However the phd installed doesn't appear to be a working version. i.e. there is no phd.bat file created which makes it is unusable on WIndows I'd guess. Hmh. Richard or Kalle, could you verify this? I'm pretty darn sure we use normal PhD installs over the channel on the Windows box to generate the CHM files.. That phd.bat _should_ be there. Niel: Please fix your From: address.. -Hannes I use the CVS (now SVN), so there is no phd.bat by default, only if installed via PEAR. So, in my case, I use phd's build.php instead. As mentioned on http://wiki.php.net/doc/phd/install#using_cvs (which is wonky with the CVS terminology, but still relevant). Richard. -- - Richard Quadling Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498r=213474731 Standing on the shoulders of some very clever giants! ZOPA : http://uk.zopa.com/member/RQuadling
Re: [PHP-DOC] Intro and quick patches
On Wed, Jul 15, 2009 at 10:45, Richard Quadlingrquadl...@googlemail.com wrote: 2009/7/15 Hannes Magnusson hannes.magnus...@gmail.com: On Wed, Jul 15, 2009 at 02:06, Niel Archern...@chance.now wrote: However the phd installed doesn't appear to be a working version. i.e. there is no phd.bat file created which makes it is unusable on WIndows I'd guess. Hmh. Richard or Kalle, could you verify this? I'm pretty darn sure we use normal PhD installs over the channel on the Windows box to generate the CHM files.. That phd.bat _should_ be there. Niel: Please fix your From: address.. -Hannes I use the CVS (now SVN), so there is no phd.bat by default, only if installed via PEAR. So, in my case, I use phd's build.php instead. What do you mean? The file is in SVN: http://svn.php.net/viewvc/phd/branches/PHD_0_4/phd.bat?view=log And you should also be able to `pear install package.xml` just fine. -Hannes
Re: [PHP-DOC] Intro and quick patches
2009/7/15 Hannes Magnusson hannes.magnus...@gmail.com: On Wed, Jul 15, 2009 at 10:45, Richard Quadlingrquadl...@googlemail.com wrote: 2009/7/15 Hannes Magnusson hannes.magnus...@gmail.com: On Wed, Jul 15, 2009 at 02:06, Niel Archern...@chance.now wrote: However the phd installed doesn't appear to be a working version. i.e. there is no phd.bat file created which makes it is unusable on WIndows I'd guess. Hmh. Richard or Kalle, could you verify this? I'm pretty darn sure we use normal PhD installs over the channel on the Windows box to generate the CHM files.. That phd.bat _should_ be there. Niel: Please fix your From: address.. -Hannes I use the CVS (now SVN), so there is no phd.bat by default, only if installed via PEAR. So, in my case, I use phd's build.php instead. What do you mean? The file is in SVN: http://svn.php.net/viewvc/phd/branches/PHD_0_4/phd.bat?view=log And you should also be able to `pear install package.xml` just fine. -Hannes I meant that the phd.bat isn't ready to use if you get phd via SVN. You don't actually need PEAR. Therefore no need to PEAR INSTALL. phd/phd.bat just calls phd/build.bat, so cutting out the middle man. But typing ... pear install package.xml from the checkedout svn folder quite happily installs phd into pear and configures the phd.bat script. Regards, Richard. -- - Richard Quadling Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498r=213474731 Standing on the shoulders of some very clever giants! ZOPA : http://uk.zopa.com/member/RQuadling
Re: [PHP-DOC] Intro and quick patches
On Wed, Jul 15, 2009 at 02:06, Niel Archern...@chance.now wrote: However the phd installed doesn't appear to be a working version. i.e. there is no phd.bat file created which makes it is unusable on WIndows I'd guess. My mistake. I was expecting to find it in the phd directory under PEAR. not in the PHP directory. Hmh. Richard or Kalle, could you verify this? I'm pretty darn sure we use normal PhD installs over the channel on the Windows box to generate the CHM files.. That phd.bat _should_ be there. Niel: Please fix your From: address.. Fixed. It's habitual for me to use a dummy address in from to avoid spam, and include my address in the sig. -Hannes -- Niel Archer niel.archer (at) blueyonder.co.uk
Re: [PHP-DOC] Intro and quick patches
On Tue, Jul 14, 2009 at 22:26, Niel Archern...@chance.now wrote: I tried getting phd installed tonight, but had problems connecting to the channel with PEAR. So instead of looking around the main docs I started looking at phd from SVN instead. Hah! Thats how contribution should start - fixing the things that you need to use to contribute :D I was gonna tell you that you could download the release tgz from http://doc.php.net/phd but apparently doc.php.net is having more problems then just the pear channel.. I'll have to look into it tomorrow morning if Philip hasn't by then (although I think he is in the middle of updating everything to use SVN on the server as we speak^Wwrite). Regarding the patches; you are adding Windows line endings.. make sure your editor is configured correctly :) Note: Our summer of code student, Moacir, is doing quite drastic changes in HEAD (trunk).. it may or may not work :) Using PhD from the PHD_0_4 branch however should work fine, as that is the current release branch. -Hannes
Re: [PHP-DOC] Intro and quick patches
On Tue, Jul 14, 2009 at 22:26, Niel Archern...@chance.now wrote: I tried getting phd installed tonight, but had problems connecting to the channel with PEAR. So instead of looking around the main docs I started looking at phd from SVN instead. Hah! Thats how contribution should start - fixing the things that you need to use to contribute :D I was gonna tell you that you could download the release tgz from http://doc.php.net/phd but apparently doc.php.net is having more problems then just the pear channel.. I'll have to look into it tomorrow morning if Philip hasn't by then (although I think he is in the middle of updating everything to use SVN on the server as we speak^Wwrite). Regarding the patches; you are adding Windows line endings.. make sure your editor is configured correctly :) Very sorry. Hadn't realised there was a conversion going on. Unfortunately, it's not my editor doing it. It's SVN. The properties on the files themselves contain svn:eol-style native, forcing them to CRLF on a Windows machine. Annoying, as I'm using Eclipse and have it set up to default to UTF-8 encoding and Unix line endings ;-) Should I resend them converted? Note: Our summer of code student, Moacir, is doing quite drastic changes in HEAD (trunk).. it may or may not work :) Using PhD from the PHD_0_4 branch however should work fine, as that is the current release branch. Ahh, OK. Thanks. I grabbed the trunk and tried installing that with PEAR also. PEAR didn't like the package.xml contents, so I will try the the the branch version. -Hannes -- Niel Archer niel.archer (at) blueyonder.co.uk
Re: [PHP-DOC] Intro and quick patches
On Jul 14, 2009, at 4:10 PM, Niel Archer wrote: On Tue, Jul 14, 2009 at 22:26, Niel Archern...@chance.now wrote: I tried getting phd installed tonight, but had problems connecting to the channel with PEAR. So instead of looking around the main docs I started looking at phd from SVN instead. Hah! Thats how contribution should start - fixing the things that you need to use to contribute :D I was gonna tell you that you could download the release tgz from http://doc.php.net/phd but apparently doc.php.net is having more problems then just the pear channel.. I'll have to look into it tomorrow morning if Philip hasn't by then (although I think he is in the middle of updating everything to use SVN on the server as we speak^Wwrite). Regarding the patches; you are adding Windows line endings.. make sure your editor is configured correctly :) Very sorry. Hadn't realised there was a conversion going on. Unfortunately, it's not my editor doing it. It's SVN. The properties on the files themselves contain svn:eol-style native, forcing them to CRLF on a Windows machine. Annoying, as I'm using Eclipse and have it set up to default to UTF-8 encoding and Unix line endings ;-) Everything should be fine now. Actually that's not true, but most things seem fine or close to working. Still some tweaking needs done with docweb+svn, a euk2 cron or three may be yelling at us, but the aforementioned site and phd pear channel work now. Should I resend them converted? Yeah, also note a couple typos in there that turned 'phpdoc' checkouts into 'phd'. Note: Our summer of code student, Moacir, is doing quite drastic changes in HEAD (trunk).. it may or may not work :) Using PhD from the PHD_0_4 branch however should work fine, as that is the current release branch. Ahh, OK. Thanks. I grabbed the trunk and tried installing that with PEAR also. PEAR didn't like the package.xml contents, so I will try the the the branch version. The channel should work fine now. 'pear install phpdocs/phd-beta' Regards, Philip
Re: [PHP-DOC] Intro and quick patches
Should I resend them converted? Yeah, also note a couple typos in there that turned 'phpdoc' checkouts into 'phd'. Diffs attached. -- Niel Archer niel.archer (at) blueyonder.co.uk phd_README.diff Description: Binary data phd_HOWTO.GENERATE_CHM.diff Description: Binary data
Re: [PHP-DOC] Intro and quick patches
Hi Everything should be fine now. Actually that's not true, but most things seem fine or close to working. Still some tweaking needs done with docweb+svn, a euk2 cron or three may be yelling at us, but the aforementioned site and phd pear channel work now. doc.php.net channel is working again. ;-) However the phd installed doesn't appear to be a working version. i.e. there is no phd.bat file created which makes it is unusable on WIndows I'd guess. I also tried using the PHD_0_4 branch from SVN. and doing: pear install -f package.xml It gave me the same installation. Using PHP v5.3.0, PEAR 1.8.1 Regards, Philip -- Niel Archer niel.archer (at) blueyonder.co.uk
Re: [PHP-DOC] Intro and quick patches
On Jul 14, 2009, at 4:36 PM, Niel Archer wrote: Should I resend them converted? Yeah, also note a couple typos in there that turned 'phpdoc' checkouts into 'phd'. Diffs attached. This diff brings up a good point for us to discuss. What is the preferred method to check something out from SVN? Most anything we do requires at least two SVN checkouts. A classic example for English: - cd /where/doc/stuff/is/stored - svn co http://svn.php.net/repository/phpdoc/en/trunk phpdoc/en - svn co http://svn.php.net/repository/phpdoc/doc-base/trunk phpdoc/ doc-base Leaving us with en and doc-base directories. And then for phpdoc-all it gets trickier, well, a lot longer. The choices seem to be either: - use svn:externals - create and promote scripts for this - change our structure/layout - ... ? I don't understand the pros and cons of using svn:externals but the topic seems to have a holy war type feel to it. Is this true and/or avoidable? What are the pros and cons? If a script is used, I imagine it'd be stored in doc-base then used to checkout languages. I also imagine other places at php.net would use it (or svn:externals). Regards, Philip
Re: [PHP-DOC] Intro and quick patches
This diff brings up a good point for us to discuss. What is the preferred method to check something out from SVN? Most anything we do requires at least two SVN checkouts. A classic example for English: - cd /where/doc/stuff/is/stored - svn co http://svn.php.net/repository/phpdoc/en/trunk phpdoc/en - svn co http://svn.php.net/repository/phpdoc/doc-base/trunkphpdoc/doc-base Leaving us with en and doc-base directories. And then for phpdoc-all it gets trickier, well, a lot longer. The choices seem to be either: - use svn:externals - create and promote scripts for this - change our structure/layout - ... ? I don't understand the pros and cons of using svn:externals but the topic seems to have a holy war type feel to it. Is this true and/or avoidable? What are the pros and cons? If a script is used, I imagine it'd be stored in doc-base then used to checkout languages. I also imagine other places at php.net would use it (or svn:externals). using svn:externals have some restrictions ( http://svnbook.red-bean.com/en/1.0/ch07s03.html) First, an externals definition can only point to directories, not files. Second, the externals definition cannot point to relative paths (paths like ../../skins/myskin). Third, the working copies created via the externals definition support are still disconnected from the primary working copy (on whose versioned directories thesvn:externals property was actually set). And Subversion still only truly operates on non-disjoint working copies. So, for example, if you want to commit changes that you've made in one or more of those external working copies, you must run svn commit explicitly on those working copies—committing on the primary working copy will not recurse into any external ones. And, svn:externals does not have a prompt so everything will be checkout-ed for everyone by the externals definition. ks
Re: [PHP-DOC] Intro and quick patches
KSChan wrote: And, svn:externals does not have a prompt so everything will be checkout-ed for everyone by the externals definition. This is not necessarily true, see http://svn.pear.php.net/wsvn/PEARSVN?op=compcompare[]=%2f...@663compare[]=%2f...@837 for an example of how to make a straight checkout do a whole bunch of externals checkouts. one simply does svn co http://svn.pear.php.net/PEAR2/all Greg
