RE: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch
-Original Message- From: Philip Olson [mailto:phi...@roshambo.org] Sent: Monday, July 11, 2011 6:45 PM To: Kalle Sommer Nielsen Cc: Jonathan Guerin; phpdoc@lists.php.net Subject: Re: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch On Jul 11, 2011, at 6:18 PM, Kalle Sommer Nielsen wrote: Hi Jonathan 2011/7/12 Jonathan Guerin jgue...@microsoft.com: Ok, we believe we have fixed the issues described, but are now running into a commit problem: Commit failed (details follow): Commit blocked by pre-commit hook (exit code 1) with output: *** Access denied: Insufficient karma for jguerin to phpdoc/doc- base/trunk/entities/global.ent. Contact phpdoc@lists.php.net for access. How can we push updates to the Global Entities file, as we need to add some links in there? Philip will have to grant you karma, as currently your account does not have access to any part of the svn tree. Greetings Jonathan, Your account lacked karma (and still does for pecl) but you now have phpdoc karma, welcome to the PHP documentation team! :) Muchly appreciated :) Thanks! Jonathan Regards, Philip
RE: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch
Oh and just a quick question - how long until the changes propagate after a commit? Thanks! Jonathan -Original Message- From: Jonathan Guerin Sent: Tuesday, July 12, 2011 10:37 AM To: 'Philip Olson'; Kalle Sommer Nielsen Cc: phpdoc@lists.php.net Subject: RE: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch -Original Message- From: Philip Olson [mailto:phi...@roshambo.org] Sent: Monday, July 11, 2011 6:45 PM To: Kalle Sommer Nielsen Cc: Jonathan Guerin; phpdoc@lists.php.net Subject: Re: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch On Jul 11, 2011, at 6:18 PM, Kalle Sommer Nielsen wrote: Hi Jonathan 2011/7/12 Jonathan Guerin jgue...@microsoft.com: Ok, we believe we have fixed the issues described, but are now running into a commit problem: Commit failed (details follow): Commit blocked by pre-commit hook (exit code 1) with output: *** Access denied: Insufficient karma for jguerin to phpdoc/doc- base/trunk/entities/global.ent. Contact phpdoc@lists.php.net for access. How can we push updates to the Global Entities file, as we need to add some links in there? Philip will have to grant you karma, as currently your account does not have access to any part of the svn tree. Greetings Jonathan, Your account lacked karma (and still does for pecl) but you now have phpdoc karma, welcome to the PHP documentation team! :) Muchly appreciated :) Thanks! Jonathan Regards, Philip
RE: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch
-Original Message- From: Philip Olson [mailto:phi...@roshambo.org] Sent: Tuesday, July 12, 2011 10:49 AM To: Jonathan Guerin Cc: Kalle Sommer Nielsen; phpdoc@lists.php.net Mailing List Subject: Re: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch On Jul 12, 2011, at 10:39 AM, Jonathan Guerin wrote: Oh and just a quick question - how long until the changes propagate after a commit? Hello Jonathan, The PHP manual updates (rsyncs to the php.net mirrors) every Friday. However, docs.php.net updates 4x daily. Uh oh. I'll be twiddling my thumbs for a while. :-) Thanks! Jonathan Regards, Philip
RE: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch
Ok, we believe we have fixed the issues described, but are now running into a commit problem: Commit failed (details follow): Commit blocked by pre-commit hook (exit code 1) with output: *** Access denied: Insufficient karma for jguerin to phpdoc/doc-base/trunk/entities/global.ent. Contact phpdoc@lists.php.net for access. How can we push updates to the Global Entities file, as we need to add some links in there? Thanks! Jonathan -Original Message- From: Philip Olson [mailto:phi...@roshambo.org] Sent: Tuesday, July 05, 2011 12:27 PM To: Jonathan Guerin Cc: phpdoc@lists.php.net Subject: Re: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch On Jul 5, 2011, at 10:43 AM, Jonathan Guerin wrote: Update: Sounds like I sent this to the wrong mailing list. Resending to the appropriate one! Hi everyone, Here is our patch for the initial addition of the PHP Manual for the SQLSRV and PDO_SQLSRV extensions. Overall it looks good and nicely detailed. However: Please cleanup the whitespace, which should include using spaces instead of tabs. And the wide line widths makes it difficult to read, so should be closer to 80 than 300 in length. And although we have a questionable and non-existent style guide (sorry about that, our bad): - A few entities worth using (common for return value descriptions): - null; instead of NULL - true; '' - false; '' - Random: - refpurpose should not contain ending periods - Adding output to examples is often useful, and is done using screen within example - where the example.outputs.similar; entity is useful in cases like this - Example within sqlsrv-num-fields.xml contains a parse error - You may want to link (and edit) the new install/cloud/azure.xml docs - Third-person active voice is preferred (don't worry about this now, too much work) And feel free to ask further questions here or casually within #php.doc on EFNet IRC. The above are common problems for new docs, and I thought all of it was written down (???) but now I cannot find. Getting old I guess. But, thanks to your efforts, this will certainly be written down so people in the future will know from the beginning and perform less work. Again, sorry about that We would love to gather feedback, as well as understand the next steps. Do we simply commit this patch once it is approved? Yes, you'll commit it then random people (including you, at any time, no approval needed) will update it in the future. Regards, Philip
RE: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch
Thanks for the feedback! :) I'll get on to the changes, wait a day for more updates, then commit it. Thank you! Jonathan -Original Message- From: Philip Olson [mailto:phi...@roshambo.org] Sent: Tuesday, July 05, 2011 12:27 PM To: Jonathan Guerin Cc: phpdoc@lists.php.net Subject: Re: [PHP-DOC] SQLSRV and PDO_SQLSRV Documentation Patch On Jul 5, 2011, at 10:43 AM, Jonathan Guerin wrote: Update: Sounds like I sent this to the wrong mailing list. Resending to the appropriate one! Hi everyone, Here is our patch for the initial addition of the PHP Manual for the SQLSRV and PDO_SQLSRV extensions. Overall it looks good and nicely detailed. However: Please cleanup the whitespace, which should include using spaces instead of tabs. And the wide line widths makes it difficult to read, so should be closer to 80 than 300 in length. And although we have a questionable and non-existent style guide (sorry about that, our bad): - A few entities worth using (common for return value descriptions): - null; instead of NULL - true; '' - false; '' - Random: - refpurpose should not contain ending periods - Adding output to examples is often useful, and is done using screen within example - where the example.outputs.similar; entity is useful in cases like this - Example within sqlsrv-num-fields.xml contains a parse error - You may want to link (and edit) the new install/cloud/azure.xml docs - Third-person active voice is preferred (don't worry about this now, too much work) And feel free to ask further questions here or casually within #php.doc on EFNet IRC. The above are common problems for new docs, and I thought all of it was written down (???) but now I cannot find. Getting old I guess. But, thanks to your efforts, this will certainly be written down so people in the future will know from the beginning and perform less work. Again, sorry about that We would love to gather feedback, as well as understand the next steps. Do we simply commit this patch once it is approved? Yes, you'll commit it then random people (including you, at any time, no approval needed) will update it in the future. Regards, Philip
RE: [PHP-DOC] Problems creating documentation
-Original Message- From: Philip Olson [mailto:phi...@roshambo.org] Sent: Thursday, June 09, 2011 5:58 PM To: Jonathan Guerin Cc: phpdoc@lists.php.net Subject: Re: [PHP-DOC] Problems creating documentation On Jun 9, 2011, at 5:02 PM, Jonathan Guerin wrote: Hi everyone, We are currently trying to create the documentation for the SQLSRV and PDO_SQLSRV, but are running into a few problems. We are getting the following error: Philip, Thanks for these tips! Hello Jonathan, The reference.xml should have very little within it, yet this is referring to constants, requirements, inis, and others. Most (all?) content is being repeated in setup.xml so instead only use setup.xml for this information. Summary: Remove everything except sqlsrv.intro from reference.xml and it'll build. Perfect, build works great now! :) Unrelated and nitpicky, but please fix all whitespace before commit which means no tabs and use single spaced indention. We're strict and weird about whitespace. :) And ideally lines won't exceed 80 characters in length, although that's a loose requirement. I will endeavor to make sure that this is done. Regards, Philip Thanks again for your assistance! Jonathan
