From a51de094aba9e272e6f216a705fc9259553dc9cc Mon Sep 17 00:00:00 2001 From: Darren Salt Date: Sun, 7 Mar 2010 18:39:55 +0000 Subject: Update docs wrt lack of CVS; retitle the FAQ list. --- doc/faq/faq.sgml | 120 ++++++++++++++++++------------------------------------- 1 file changed, 39 insertions(+), 81 deletions(-) (limited to 'doc/faq/faq.sgml') diff --git a/doc/faq/faq.sgml b/doc/faq/faq.sgml index b3490ea2a..2519a8118 100644 --- a/doc/faq/faq.sgml +++ b/doc/faq/faq.sgml @@ -3,15 +3,16 @@ - The xine engine FAQ - xine FAQ + The xine engine FAQ list + xine FAQs - 2001-2008 + 2001-2010 the xine project team -
+
+ General questions about xine and this document @@ -75,7 +76,7 @@ - What are those xine-lib, xine-ui, gnome-xine, … modules in cvs for? + What are those xine-lib, xine-ui, gxine, … Mercurial repositories for? Some time ago xine just became too complex to be just one big program. Therefore it was split into two major parts. @@ -88,10 +89,10 @@ Then there are frontends – applications that use xine. The most common frontend is that of a media player. There are currently - two frontends being developed in the xine project, xine-ui (skinned - dvd-player style frontend directly based on xlib) and gxine, - a desktop media-player style frontend using the standard gtk widget set - and comes with a mozilla browser plugin. + three frontends being developed in the xine project: xine-ui, a skinned + dvd-player style frontend directly based on xlib; gxine, a desktop + media-player style frontend using the standard GTK widget set; and + xine-plugin, a plugin for browsers such as Firefox. External projects like kaffeine, sinek and totem develop additional frontends. In the future you will likely see more and different types of applications being developed which will use the xine engine for video processing @@ -102,90 +103,47 @@ first and then choose and install a player frontend like xine-ui or gxine. - Other modules in CVS are: xine-plugin a mozilla browser plugin - for streaming media playback using xine, - xine_www the - xine project website sources. + Other repositories include xine-project-www, + which contains the xine project website sources, and various packaging + and development branches. - + Where and how do I get the latest development version? Be advised that end-users should stick to the official xine releases. - The CVS and Mercurial repositories are only intended for developers and for others who know why they use it. + The Mercurial repositories are only intended for developers and for others who know why they use it. - - Checking out xine modules from Mercurial - - The repositories are listed at http://hg.debian.org/hg/; - however, this is a list of all repositories which are kept there, not just the - xine project's (which are the ones which begin with xine-lib/). To check one out: -    hg clone http://hg.debian.org/hg/repository local_copy - e.g. -    hg clone http://hg.debian.org/hg/xine-lib/xine-lib xine-lib - - - Currently, only xine-lib and gxine are present here. - - - - Checking out xine modules from CVS - - To check out xine modules from CVS, first do this: -    cvs -d :pserver:anonymous@xine.cvs.sourceforge.net:/cvsroot/xine login - The password is empty, just press Enter. - - - Then, to check out individual modules (e.g. xine-lib or xine-ui): -    cvs -d :pserver:anonymous@xine.cvs.sourceforge.net:/cvsroot/xine co <modulename> - - - If you want xine-lib or gxine, you should use Mercurial instead. - The CVS repositories for these are not maintained. - - - - - - How do I submit patches? - First, make sure that you're using a current development version - (see above) or at least the current release version. Then, once you're - ready to send the patch… + The repositories are listed at http://hg.debian.org/hg/; + however, this is a list of all repositories which are kept there, not just the + xine project's (which are the ones which begin with xine-lib/). To check one out: +    hg clone http://hg.debian.org/hg/repository local_copy + e.g. +    hg clone http://hg.debian.org/hg/xine-lib/xine-lib xine-lib - Generate your patch using either cvs diff -u > - my.patch or hg diff > my.patch (as - appropriate). Make sure that your message subject briefly describes the - patch; your message body should contain a longer description of the - patch. Your patch should be applicable using patch -p0 -i - my.patch or, preferably, patch -p1 -i - my.patch from the top-level directory in the source tree - (i.e. where configure.ac is) – this is fairly important for our - Mercurial-based repositories since it makes importing your patch that - much easier (hg import defaults to -p1). - - - Alternatively, if you've been hacking away at a module which is - maintained using mercurial, you can make them available as diffs – use - hg export or, if you have several patches, you could - use hg bundle instead (both require extra - parameters; hg help export and hg help - bundle for more details) – or via HTTP by using hg - serve. In the latter case, you'll need to post a URL from - which a developer can pull the changes. + You can see a full list of repositories by visiting + http://hg.debian.org/hg/xine-lib/. + + + + Don't you use CVS? - Patches should normally be sent to the xine-devel mailing list, - xine-devel@lists.sourceforge.net. + We used to, but there are some significant problems with CVS. Merging + is easier with Mercurial (and, for that matter, git); and we can commit + changes locally, change them if mistakes have been made, then make them + public whenever we're ready. - - Why is gxine's CVS module named "gnome-xine"? + + How do I submit patches? - Historical reasons: gxine was originally named gnome-xine. + See the xine Hackers' Guide, chapter 3, "How to contribute". + (This is available online at http://www.xine-project.org/hackersguide#contribute.) @@ -226,7 +184,7 @@ often found in a package called zlib-devel or similar.) - If you want to compile xine from CVS, you'll need to have the autobuild tools + If you want to compile xine from Mercurial, you'll need to have the autobuild tools installed (automake, autoconf and libtool – in recent versions). @@ -304,7 +262,7 @@ Last but not least. Here the build instructions. As stated earlier, those are the same for every xine module. -   ./autogen.sh [→ only if you checked your sources out of CVS] +   ./autogen.sh [→ only if you're building from hg]    ./configure    make    make install @@ -328,7 +286,7 @@ (e.g. /usr/src/RPM/SRPMS). - In case that you have a fresh CVS checkout, you will need to do the + In case that you have an up-to-date hg repository, you will need to do the following first in order to get a tarball release out of it which you can later use with the rpmbuild -ta command above:    ./autogen.sh && make clean && make dist @@ -342,7 +300,7 @@ Making your own .deb packages (xine-lib, xine-ui, gxine) - You'll need a CVS or HG snapshot tarball or source checked out from the repository. + You'll need an HG snapshot tarball or source checked out from the repository. First, make sure that the "devscripts" package is installed. You'll -- cgit v1.2.3