Mailinglist Archive: zypp-commit (266 mails)

< Previous Next >
[zypp-commit] r11732 - /trunk/libzypp/doc/autoinclude/Mainpage.doc
  • From: dmacvicar@xxxxxxxxxxxxxxxx
  • Date: Wed, 19 Nov 2008 22:45:18 -0000
  • Message-id: <20081119224518.E815CDF694@xxxxxxxxxxxxxxxx>
Author: dmacvicar
Date: Wed Nov 19 23:45:18 2008
New Revision: 11732

URL: http://svn.opensuse.org/viewcvs/zypp?rev=11732&view=rev
Log:
add main page

Modified:
trunk/libzypp/doc/autoinclude/Mainpage.doc

Modified: trunk/libzypp/doc/autoinclude/Mainpage.doc
URL:
http://svn.opensuse.org/viewcvs/zypp/trunk/libzypp/doc/autoinclude/Mainpage.doc?rev=11732&r1=11731&r2=11732&view=diff
==============================================================================
--- trunk/libzypp/doc/autoinclude/Mainpage.doc (original)
+++ trunk/libzypp/doc/autoinclude/Mainpage.doc Wed Nov 19 23:45:18 2008
@@ -1,6 +1,67 @@
-/** \namespace zypp libzypp
-*/
-** \mainpage Welcome to libzypp
+/** \mainpage Welcome to libzypp

+\section intro Introduction
+
+Welcome to the libzypp documentation.
+
+libzypp is the package management library that powers applications like YaST,
zypper and the openSUSE/SLE implementation of PackageKit.
+
+\section whatis What is libzypp?
+
+libzypp provides all the functionality for a package manager:
+
+- An API for package repository management, supporting most common repository
metadata formats and signed repositories.
+- An API for solving packages, products, patterns and patches (installation,
removal, update and distribution upgrade operations) dependencies, with
additional features like locking.
+- An API for commiting the transaction to the system over a rpm target.
Supporting deltarpm calculation, media changing and installation order
calculation.
+- An API for browsing available and installed software, with some facilities
for programs with an user interface.
+- A suite of maintained solving testcases representing common and uncommon
operations on Linux software management
+
+\section impl Implementation
+
+libzypp is implemented as a C++ library with experimental bindings available
for python and ruby.
+
+\section otherfunc Other functionality offered by libzypp
+
+Most of libzypp functionality is implemented over components provided also by
libzypp:
+
+- Media abstraction library offering a common interface over local files,
http,ftp,iso,nfs and other protocols.
+
+\section thirdpfunc 3rd party software libzypp is based on
+
+Additionally, some functionality libzypp uses is based on 3rd party libraries:
+
+- SAT solver library, for dependency solving and repository data storage and
querying
+- curl, that powers some protocols of the media abstraction component
+- boost, for misc. utilities like shared pointers, functors and algorithms.
+
+\section join Join the community
+
+Visit our web site at : http://en.opensuse.org/Libzypp or #zypp on
irc.freenode.net
+
+\section license License
+
+\code
+/*---------------------------------------------------------------------\
+| ____ _ __ __ ___ |
+| |__ / \ / / . \ . \ |
+| / / \ V /| _/ _/ |
+| / /__ | | | | | | |
+| /_____||_| |_| |_| |
+| |
+\---------------------------------------------------------------------*/
+
+Copyright (C) 2000-2002 Ximian, Inc.
+Copyright (C) 2005 SUSE Linux Products GmbH
+
+ZYpp is licensed under the GNU General Public License version 2
+or later. The text of the GNU General Public License can be viewed at
+http://www.gnu.org/licenses/gpl.html
+
+As a special exception, you have permission to link this program
+with the following libraries and distribute executables, as long as you
+follow the requirements of the GNU GPL in regard to all of the
+software in the executable aside from the following libraries:
+- OpenSSL (http://www.openssl.org)
+\endcode

*/
\ No newline at end of file

--
To unsubscribe, e-mail: zypp-commit+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: zypp-commit+help@xxxxxxxxxxxx

< Previous Next >
This Thread
  • No further messages