You are not logged in.
- Topics: Active | Unanswered
Pages: 1
#1 2010-09-22 18:55:22
- MTK358
- Member
- Registered: 2010-09-22
- Posts: 9
libalpm Documentation
Any good documentation for libalpm?
All I can find is "man libalpm", and the pages listed there don't exist.
Offline
#2 2010-09-22 19:11:32
- Xyne
- Administrator/PM
- Registered: 2008-08-03
- Posts: 6,965
- Website
Re: libalpm Documentation
It's a well kept secret.
It's in a vault somewhere with the Arch Taco Reserves.
My Arch Linux Stuff • Forum Etiquette • Community Ethos - Arch is not for everyone
Offline
#3 2010-09-22 21:39:19
- Allan
- Pacman
- From: Brisbane, AU
- Registered: 2007-06-09
- Posts: 11,487
- Website
Re: libalpm Documentation
There is reasonable function documentation within the code and we provide pacman as an example of using libalpm... It is definitely an area that a lot more help is needed.
Offline
#4 2010-09-23 00:46:04
- MTK358
- Member
- Registered: 2010-09-22
- Posts: 9
Re: libalpm Documentation
Sadly I'm not good at reading others' code, but maybe...
Anyway, I think I remember once seeing some Doxygen documentation for it, but can't seem to find it again.
Offline
#5 2010-09-23 00:47:19
- karol
- Archivist
- Registered: 2009-05-06
- Posts: 25,440
Re: libalpm Documentation
http://www.archlinux.org/pacman/libalpm.3.html ;P
https://bugs.archlinux.org/task/9237?pr … &pagenum=7 : http://code.toofishes.net/pacman/doc/index.html
Last edited by karol (2010-09-23 00:49:38)
Offline
#6 2010-09-23 00:50:57
- Allan
- Pacman
- From: Brisbane, AU
- Registered: 2007-06-09
- Posts: 11,487
- Website
Re: libalpm Documentation
That is just the man page, which as already mentioned contains next to no information....
Not sure if this is up to date (in fact it is probably not....) but: http://code.toofishes.net/pacman/doc/
And as I said, most of public interfaces to libalpm have documentation in their function header. Probably in something close to doxygen format too.
Offline
#7 2010-09-23 00:57:39
- karol
- Archivist
- Registered: 2009-05-06
- Posts: 25,440
Re: libalpm Documentation
That is just the man page, which as already mentioned contains next to no information.....
That's why I appended the smiley ;P with a wink and a tongue.
And as I said, most of public interfaces to libalpm have documentation in their function header. Probably in something close to doxygen format too.
From the Support Request I linked to:
Some doxygen docs are available. Download the source tarball and configure with --enable-doxygen, or clone the GIT repo and do the same.
Offline
Pages: 1