Re: Extension changelogs

On Tue, Jun 5, 2012 at 7:13 PM, Moacir de Oliveira <moacirdeoliveira.eng@gmail.com> wrote: > Hi, > > 2012/6/5 Christopher Jones <christopher.jones@oracle.com> >> >> >> On 06/05/2012 10:31 AM, Hannes Magnusson wrote: >>> >>> >>> Soo... to start the process I patched PhD to aggregate all the exiting >>> changelog entries and spit them out in a new document. >>> >>> It should be fairly easy to actually even spit out a complete >>> changelog page for every version of PHP automatically on >>> php.net/manual/changelog.php for example. >>> >>> Attached is the PhD patch and trivial phpdoc patch. >>> >>> >>> Screenshots: >>> - http://prntscr.com/a5yml ("ext/strings") >>> - http://prntscr.com/a5yq2 (ext/mysql) >>> - http://prntscr.com/a5yrv ("ext/misc") >>> >>> -Hannes >> >> >> Hi Hannes, >> >> Looks fine.  Perhaps the repeating version numbers are a little >> tedious and the sentence "Here is a list..." isn't needed, but neither >> is a huge issue. >> > > > Why not just phd:args="arg1, arg2, arg3...", so we will not have a limited > number of arguments in the dtd specification. Whopsy. That was the wrong patch for phpdoc. That was for the "ext/mysql updates (~deprecated)" thread. Attached is the correct phpdoc for this thread :) -Hannes

Index: en/language-defs.ent =================================================================== --- en/language-defs.ent (revision 325983) +++ en/language-defs.ent (working copy) @@ -52,6 +52,8 @@ <!ENTITY FunctionListingDescription "List of all the functions and methods in the manual"> <!ENTITY ExampleListing "Example listing"> <!ENTITY ExampleListingDescription "List of all the examples in the manual"> +<!ENTITY ChangelogListingTitle "Changelog"> +<!ENTITY ChangelogListingDescription "Here is a list of changes to functions in this extension."> <!ENTITY CHMEdition "HTML Help Edition"> <!ENTITY ReservedConstants "Predefined Constants"> <!ENTITY MissingStuff "Missing Stuff"> Index: en/reference/misc/book.xml =================================================================== --- en/reference/misc/book.xml (revision 325983) +++ en/reference/misc/book.xml (working copy) @@ -18,7 +18,13 @@ &reference.misc.setup; &reference.misc.constants; &reference.misc.reference; - + +<appendix xmlns="http://docbook.org/ns/docbook" xml:id="changelog.misc"> + <title>&ChangelogListingTitle;</title> + <para>&ChangelogListingDescription;</para> + <?phpdoc generate-changelog-for="ref.misc"?> +</appendix> + </book> <!-- Keep this comment at the end of the file Index: en/reference/strings/book.xml =================================================================== --- en/reference/strings/book.xml (revision 325983) +++ en/reference/strings/book.xml (working copy) @@ -25,6 +25,12 @@ &reference.strings.constants; &reference.strings.reference; +<appendix xmlns="http://docbook.org/ns/docbook" xml:id="changelog.strings"> + <title>&ChangelogListingTitle;</title> + <para>&ChangelogListingDescription;</para> + <?phpdoc generate-changelog-for="ref.strings"?> +</appendix> + </book> <!-- Keep this comment at the end of the file Index: en/reference/mysql/book.xml =================================================================== --- en/reference/mysql/book.xml (revision 325983) +++ en/reference/mysql/book.xml (working copy) @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="utf-8"?> <!-- $Revision$ --> <!-- Membership: bundled, external --> - + <book xml:id="book.mysql" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>Original MySQL API</title> <titleabbrev>Mysql</titleabbrev> - + <!-- {{{ preface --> <preface xml:id="intro.mysql"> &reftitle.intro; @@ -27,12 +27,18 @@ </para> </preface> <!-- }}} --> - + &reference.mysql.setup; &reference.mysql.constants; &reference.mysql.examples; &reference.mysql.reference; +<appendix xmlns="http://docbook.org/ns/docbook" xml:id="changelog.mysql"> + <title>&ChangelogListingTitle;</title> + <para>&ChangelogListingDescription;</para> + <?phpdoc generate-changelog-for="ref.mysql"?> +</appendix> + </book> <!-- Keep this comment at the end of the file