PEAR CS Documentation Incorrect?

[Chuck Burgess]

As you can see by the highlighting, that example is b0rked.
I assume the documentor was trying to prevent the $Id$ keyword being
expanded by SVN.
This _could_ also be a bug in the application rendering the markup
(PhD)...
Please file this as a documentation bug report :]

http://bugs.php.net/bug.php?id=47679
Regards,
Mark

I took a look at that PHP bug, as well as looking at both the example in the
docs and its source in standards.xml. Since both occurrences are examples
of usage, should it matter if CVS/SVN expands the $Id$ keyword? If it
doesn't, then the example shows you what you should write in your @version
tag... if it does, the example shows what a fully expanded @version tag
looks like. Either/both are reasonable example content, IMO. If there are
no objections to this line of thinking, then I can solve the bug by simply
using "$Id$" in those two instances and commit it.

Thoughts?

[Ken Guest]

Chuck
you're proposed solution makes sense - it is an example after-all...


k.

Post by Chuck Burgess

As you can see by the highlighting, that example is b0rked.
I assume the documentor was trying to prevent the $Id$ keyword being
expanded by SVN.
This _could_ also be a bug in the application rendering the markup
(PhD)...
Please file this as a documentation bug report :]

http://bugs.php.net/bug.php?id=47679
Regards,
Mark

I took a look at that PHP bug, as well as looking at both the example in the
docs and its source in standards.xml. Since both occurrences are examples
of usage, should it matter if CVS/SVN expands the $Id$ keyword? If it
looks like. Either/both are reasonable example content, IMO. If there are
no objections to this line of thinking, then I can solve the bug by simply
using "$Id$" in those two instances and commit it.
Thoughts?
--
CRB

[Jan Rosier]

With subversion keyword substitution is "file-based". You can turn it
off by removing the svn:keywords property on that file.

With no svn:keywords property set on that file, Subversion will do
nothing special.

http://svnbook.red-bean.com/en/1.5/svn-book.html#svn.advanced.props.special.keywords

Just my 2 cents,
Jan Rosier

Post by Ken Guest
Chuck
you're proposed solution makes sense - it is an example after-all...
k.
On Wed, Sep 9, 2009 at 12:24 PM, Chuck Burgess

Post by Chuck Burgess

As you can see by the highlighting, that example is b0rked.
I assume the documentor was trying to prevent the $Id$ keyword being
expanded by SVN.
This _could_ also be a bug in the application rendering the markup
(PhD)...
Please file this as a documentation bug report :]

http://bugs.php.net/bug.php?id=47679
Regards,
Mark

I took a look at that PHP bug, as well as looking at both the
example in
the
docs and its source in standards.xml. Since both occurrences are examples
of usage, should it matter if CVS/SVN expands the $Id$ keyword? If it
looks like. Either/both are reasonable example content, IMO. If there are
no objections to this line of thinking, then I can solve the bug by simply
using "$Id$" in those two instances and commit it.
Thoughts?
--
CRB

--
http://blogs.linux.ie/kenguest/

[Chuck Burgess]

Since there's no keyword substitution property already set on the file,
plain old "$Id$" should do it then... I've committed that fix now.
CRB

With subversion keyword substitution is "file-based". You can turn it off
by removing the svn:keywords property on that file.
With no svn:keywords property set on that file, Subversion will do nothing
special.
http://svnbook.red-bean.com/en/1.5/svn-book.html#svn.advanced.props.special.keywords
Just my 2 cents,
Jan Rosier
Chuck

Post by Ken Guest
you're proposed solution makes sense - it is an example after-all...
k.

Post by Chuck Burgess

As you can see by the highlighting, that example is b0rked.

I assume the documentor was trying to prevent the $Id$ keyword being
expanded by SVN.
This _could_ also be a bug in the application rendering the markup
(PhD)...
Please file this as a documentation bug report :]

http://bugs.php.net/bug.php?id=47679
Regards,
Mark

I took a look at that PHP bug, as well as looking at both the example in the
docs and its source in standards.xml. Since both occurrences are examples
of usage, should it matter if CVS/SVN expands the $Id$ keyword? If it
looks like. Either/both are reasonable example content, IMO. If there are
no objections to this line of thinking, then I can solve the bug by simply
using "$Id$" in those two instances and commit it.
Thoughts?
--
CRB

--
http://blogs.linux.ie/kenguest/

[Hannes Magnusson]

Post by Chuck Burgess
Since there's no keyword substitution property already set on the file,
plain old "$Id$" should do it then... I've committed that fix now.

Doesn't that break your translation versioning?
phpdoc atleast uses the revision tags to see if a translated file is
outofdate...

-Hannes

[Chuck Burgess]

On Thu, Sep 10, 2009 at 3:58 AM, Hannes Magnusson <

Post by Hannes Magnusson

Post by Chuck Burgess
Since there's no keyword substitution property already set on the file,
plain old "$Id$" should do it then... I've committed that fix now.

Doesn't that break your translation versioning?
phpdoc atleast uses the revision tags to see if a translated file is
outofdate...
-Hannes

It looks to me like the 24 occurrences of *$Id* in the 3500+ files of
peardoc/en are all literal text usages rather than actual $Id$ versioning of
the files themselves. As such, I'm guessing that versioning scheme is not
in play here. In fact, I see some that are clearly supposed to only be the
"$Id$" string used in sentences, but are expanded out (presumably committed
that way back in the CVS days). These instances probably need to be edited
back down to just "$Id$".

A good point to review though... thanks for highlighting it, Hannes.