Re: re-formatting CREDITS file

Pierre Joye wrote: >> The pickle command relies upon a few files to do its magic, such as >> >> README >> CREDITS >> RELEASE-X.Y.Z >> > > Does it support text formatting like markdown or rest? that would even better. > No, the text is copied verbatim into <summary> <description> and <notes> fields of package.xml (with appropriate encoding and escaping of &lt; and friends). Of course, this is just how I wrote the code, and the best part (I think) about Pyrus is there is a distinct separation of the developer tools from the core installer, thus it will be easy and economical to bloat^H^H^H^Hadd as many features as people need into the developer tools. Personally, I would tend to wonder if the README/CREDITS files are the best place for complex formatting? However, one can easily do a format like wiki markup which is still human-readable, and it solves your problem and mine without any need to change the code. :) >> However, the current format of the CREDITS file only contains names. >> Would it be possible for people to standardize the format of this file? >> The best would be: >> > > The format describes below is fine from an information point of view. > One thing to keep in mind is that this file is used to generate the > Credits page in phpinfo() which should contain only names (I don't > think we should clutter it with all these details). It should be easy > to update the generation script to support this new format (script is > in php-src). > Perhaps there would need to be some kind of marker in CREDITS that the script would look for? I implemented (arbitrarily) ;; as a comment, so it could be a requirement that if you plan to use the new Pyrus-compatible format, your file would look like: ;; extensionname maintainers (or any other comment you want to put in here) Full Name [handle] <email@example.com> (role) So the script could simply check for $line1[0] == ';' and jump to parsing the new format. Sound reasonable? Greg