Date: Fri, 5 Jul 2013 02:34:28 GMT From: mattbw@FreeBSD.org To: svn-soc-all@FreeBSD.org Subject: socsvn commit: r254091 - soc2013/mattbw Message-ID: <201307050234.r652YSLB087267@socsvn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: mattbw Date: Fri Jul 5 02:34:28 2013 New Revision: 254091 URL: http://svnweb.FreeBSD.org/socsvn/?view=rev&rev=254091 Log: Added README. Added: soc2013/mattbw/README Added: soc2013/mattbw/README ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ soc2013/mattbw/README Fri Jul 5 02:34:28 2013 (r254091) @@ -0,0 +1,69 @@ +PackageKit backend for pkgng +http://wiki.freebsd.org/SummerOfCode2013/pkgPackagekit +-------------------------------------------------------------------------------- + +This is a Google Summer of Code project to create a PackageKit backend for the +FreeBSD pkgng package manager. + +It is licenced under the GNU General Public License version 2+ (this is because +it links to PackageKit itself, which is under this licence). + +-------------------------------------------------------------------------------- + +REQUIREMENTS + +- PackageKit (currently building against version 0.6.11; the code MAY work with + versions 0.7.x but WILL NOT YET work with 0.8.x due to API incompatibilities) +- pkgng (currently building against version 1.1.3; higher versions might work) +- FreeBSD (tested with 9.1; should work with higher versions) + +Tested primarily with clang in C99 mode; C89 mode likely will not work and C11 +would not work due to header file problems. GNU extensions probably won't break +the build. + +-------------------------------------------------------------------------------- + +COMPILING + +This backend currently builds using the BSD make system. Using GNU Make (gmake) +will *not* work. (Porting to GNU Autotools is an exercise for the reader.) + +To compile and install the backend: + - Ensure you have the correct versions of PackageKit and pkgng installed as + directed above. + - Run `make`, or some variation thereon, in the 'backend' directory. + (I prefer to run `scan-build --use-cc=clang33 make` with WARNS=7 set, but + this involves clang33 being installed.) + - Run `make install` as root to install the backend into PackageKit's backends + directory. + - Edit /usr/local/PackageKit/PackageKit.conf such that "DefaultBackend=pkgng" + (or manually invoke packagekitd with backend=pkgng). + +-------------------------------------------------------------------------------- + +TESTING + +Currently, testing facilities are very limited. Testing will likely occur in +full after the basic featureset has been roughly implemented. + +There is currently one test, in the tests/get-details-output directory; this +checks the GetDetails output from pkcon against a mockup built from `pkg query` +to make sure it outputs sane data. At the time of writing, it is not finished, +but to run it cd to that directory, run `make`, ensure `pkcon` is set up to use +pkgng as its backend, then run `./test.sh`. + +-------------------------------------------------------------------------------- + +KNOWN BUGS + +- InstallPackages is not yet fully implemented. +- Licence emitting is broken; it currently emits only the first licence in a + licence chain, rather than the entire set of licences. +- Minor cosmetic issues (progress bars not updating properly, etc.) may exist. + +-------------------------------------------------------------------------------- + +CONTACT DETAILS + +Student: Matt Windsor <mattbw@FreeBSD.org> +Mentor: Julien Laffaye <jlaffaye@FreeBSD.org>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201307050234.r652YSLB087267>