[pacman-dev] [PATCH] doc: Document pkgver() function

[Xyne]

On 2013-04-24 15:15 +1000
Allan McRae wrote:

>On 23/04/13 17:15, William Giokas wrote:
>> Originally from Jason St. John's patch, This is a much simplified
>> version explaining some basic functions the four vcs's makepkg supports
>> can use to get package version information.

/snip

>Also, note I added "Example commands" above so the we know these are
>commands.  I'd put the command first (in the source block) and the
>example output after.

I've seen pkgver functions for Git popping up that include hashtags in the
version. I expect that this will become a widespread problem for vercmp-based
ordering if it is not discouraged. Perhaps you can add a note about that in the
documentation, e.g.

"The pkgver function should generate a version string that is correctly ordered
in all cases by Pacman's vercmp command. For example, Git hash tags should be
avoided as these are pseudo-random. Refer to the vercmp man page for
information about how Pacman orders different version strings."

Regards,
Xyne