Merge lp:~rockstar/entertainer/documentation-cleanup into lp:entertainer

[Paul Hummer]

[Paul Hummer (rockstar)]

This branch removes a lot of old, antequated documentation, converts the
HACKING file to restructured text, and consolidates the COPYING and LICENSE
files into one file. It also adds a new make target to generate a dependency
graph (and adds the current dependency graph). That part requires sfood, which
I will package when I have time, but it's not a priority. Basicaly, I'm using
the make target to store my recipe for generating the graph. I also thought we
could use it to see where we can make changes and make those dependencies less
hairy crazy.

--
Paul Hummer
http://theironlion.net
1024/862FF08F C921 E962 58F8 5547 6723 0E8C 1C4D 8AC5 862F F08F

[Matt Layman (mblayman)]

1) I don't understand why the to_dict stuff had to be merged in this branch. It seem unnecessary.

2) There is still a developer_documentation.pdf file that was left behind (now with no source file!).

3) Do we really need the user_guide.tex? It's outdated (it still refers to the 0.1 release); it's basically unmaintained; and we maintain the wiki.

4) The dependency png is basically unreadable. It's interesting to see the web of relationships, but it doesn't have the resolution to actually tell what we're looking at. Any tips for installing sfood to play around with it?

Those issues aside, the branch seems fine to me.

review: Approve

[Matt Layman (mblayman)]

"1) I don't understand why the to_dict stuff had to be merged in this branch. It seem unnecessary.

2) There is still a developer_documentation.pdf file that was left behind (now with no source file!).

3) Do we really need the user_guide.tex? It's outdated (it still refers to the 0.1 release); it's basically unmaintained; and we maintain the wiki.

4) The dependency png is basically unreadable. It's interesting to see the web of relationships, but it doesn't have the resolution to actually tell what we're looking at. Any tips for installing sfood to play around with it?

Those issues aside, the branch seems fine to me."

After a second glance at the diff, it looks like you're gzipping the man page too late. When you run the gzip command, the man page has already been installed in /usr and it's probably been installed uncompressed.

[Paul Hummer (rockstar)]

Matt-

> 1) I don't understand why the to_dict stuff had to be merged in this
> branch. It seem unnecessary.

Well, I branched from a local mirror of trunk that already had the to_dict
stuff merged in. Somehow, that never got pushed. The merge proposal itself
sent an email with the actual diff, as well as placed it where it can be seen
from the web ui, so merging it into your copy of trunk was probably a bit
misleading.

>
> 2) There is still a developer_documentation.pdf file that was left behind
> (now with no source file!).

Yeah, after looking over that, I thought it might be good to keep it while I
hacked through a replacement backend (for reference). That's why to source
file was removed, but I kept the pdf. Eventually, I'll also delete that.

>
> 3) Do we really need the user_guide.tex? It's outdated (it still refers to
> the 0.1 release); it's basically unmaintained; and we maintain the wiki.
>

Well, I wasn't sure if we'd want to keep it. If nothing else, that information
would probably be better in the man page anyway. I've removed it for now.

> 4) The dependency png is basically unreadable. It's interesting to see the
> web of relationships, but it doesn't have the resolution to actually tell
> what we're looking at. Any tips for installing sfood to play around with it?

Well, I just downloaded the tarball, put the package in my pythonpath and
used the scripts in came with. The dependency graph is kinda unreadable now,
but I think I just need to limit the amount of nodes it shows, or find a way to
generate many smaller dependency graphs. I think it will help to see how our
package organization is bass-ackwards -- I want to reorganize as I slowly
remove entertainerlib.backend, but I wanted a snapshot of what it looked like
before, if nothing else.

I'm working on the man page zipping now.

--
Paul Hummer
http://theironlion.net
1024/862FF08F C921 E962 58F8 5547 6723 0E8C 1C4D 8AC5 862F F08F

[lp:~rockstar/entertainer/documentation-cleanup]

347. By Paul Hummer on 2009-02-10

Changed when the man page gets gzipped

348. By Paul Hummer on 2009-02-10

Merge from trunk

=== modified file 'Makefile'
--- Makefile	2008-12-19 05:29:55 +0000
+++ Makefile	2009-02-01 19:35:11 +0000
@@ -24,6 +24,7 @@
 TOOLS_DIR=cd tools
 TRANSLATE= ${PYTHON} translations_generator.py
 
+
 check: test lint
 
 lint:
@@ -53,3 +54,12 @@
 clean:
 	${DOCS_DIR};${DOCS_CLEAN}
 	${CTAGS_CLEAN}
+
+depgraph:
+	sfood entertainerlib > /tmp/entertainer.deps
+	cd entertainerlib ; ls -1d * > /tmp/entertainer-clusters
+	cat /tmp/entertainer.deps | sfood-cluster -f /tmp/entertainer-clusters > /tmp/clustered
+	cat /tmp/clustered | sfood-graph -p | dot -T png > docs/entertainer-depgraph.png
+
+
+

=== modified file 'docs/COPYING'
--- docs/COPYING	2008-06-25 02:15:19 +0000
+++ docs/COPYING	2009-02-01 05:26:57 +0000
@@ -1,4 +1,344 @@
-Entertainer copyrights can be found within the individual source files.
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
+
+== Entertainer Caveats ==
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -18,8 +358,4 @@
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
-MA 02110-1301, USA.
 

=== modified file 'docs/DEPENDENCIES'
--- docs/DEPENDENCIES	2009-01-06 23:52:09 +0000
+++ docs/DEPENDENCIES	2009-02-01 05:32:19 +0000
@@ -1,6 +1,17 @@
-To install all dependencies in Hardy:
-
-sudo apt-get install python-gobject python-gtk2 python-gst0.10 python-clutter \
-python-pysqlite2 python-cddb python-glade2 python-cairo python-feedparser \
-python-eyed3 python-pyvorbis python-imaging python-imdbpy python-notify
+python-cairo
+python-cddb
+python-clutter
+python-eyed3
+python-feedparser
+python-glade2
+python-gobject
+python-gst0.10
+python-gtk2
+python-imaging
+python-imdbpy
+python-notify
+python-pysqlite2
+python-pyvorbis
+python-storm
+python-twisted
 

=== modified file 'docs/HACKING'
--- docs/HACKING	2008-10-06 01:33:50 +0000
+++ docs/HACKING	2009-02-01 06:07:50 +0000
@@ -1,4 +1,5 @@
-== Introduction ==
+Introduction
+============
 
 This document will detail a list of best practices and guidelines for
 developers. We would like to encourage community development of Entertainer,
@@ -10,86 +11,14 @@
 tools of the Entertainer developers, and will be the best method of
 communication with other developers.
 
-== Bug Workflow ==
-
-Each launchpad project probably uses the bug management system in slightly
-different ways. The following information describes how Entertainer uses lp's
-bug system.
-
-1) New bugs come in. Bugs from regular users will always come in with a status
-of New and Undecided. Entertainer developers have the ability to set new bugs
-to have some status other than New and Undecided, but we try to adopt a policy
-of letting other developers confirm our bugs (this is a way to keep us
-accountable and to ensure that the bug is, in fact, true for others too).
-
-2) If someone else wrote the bug, we check it to see what kind of information
-it has. It may have tracebacks, but sometimes reporters don't give us useful
-stuff. If that is the case, we request more information (like the log file in
-~/.config/entertainer) and mark it "Incomplete" and leave the priority
-Undecided.
-
-3) If you see a new bug, and can verify it, but have no idea how it should be
-fixed, it should be marked as "Confirmed". If you can provide extra new
-information that might help someone else figure out the problem, please add
-that to the bug. You may mark the priority at this time if you have a good
-feeling for what it should be.
-
-4) If you see a new bug, and can verify it, and you have a good idea about
-where/how the bug can be fixed, mark it as "Triaged". At this time, use your
-best judgment about setting the priority. You can see from our bug page that
-most of the bugs are in the Triaged state (we just don't have the manpower to
-handle them all).
-
-5) From the list of Triaged bugs, you would assign yourself work (or
-potentially assign someone else work). For example, problems with the RSS feeds
-are typically assigned to Josh Scotton since he was the initial developer of
-that functionality. For bugs that you're actually working on, you should assign
-yourself the bug, and change the state to "In Progress". If you're not going to
-work the bug yet, leave the state as "Triaged."
-
-6) At this point, the bug flow basically halts while you work on your branches
-in bazaar. We recommend that you create specific branches and link them to bugs
-that you are fixing. A good rule of thumb is one branch per bug, but this is
-not set in stone. You write your code, go through the merge proposal review
-process, and your code gets committed to the trunk.
-
-7) Now, either you (the developer who was working the bug) or a member of the
-Release Team (either Paul Hummer or Matt Layman) will set the bug to Fix
-Committed after the branch has landed in the trunk. Note: We do NOT mark bugs
-as Fix Committed until they land in the trunk. Everyone's first tendency is to
-mark a bug as Fix Committed as soon as it is done in their branch. Fix
-Committed does not mean "committed to my branch." We want it to mean "committed
-to the trunk."
-
-8) When we finish the release and make source tarballs and packages available,
-a member of the Release Team will mark all the Fix Committed bugs that were in
-that release as Fix Released.
-
-== Development Process ==
+
+Development Process
+===================
 
 In order to have your branch merged into trunk, there is a workflow you'll need
 to follow.  This facilitates the help of the community in working with
 Entertainer.
 
-When a bug or feature is to be implemented, a branch of
-lp:~entertainer-releases/entertainer/devel is created, named bug-<bugno> or
-<feature-name>. Once it is branched, it needs to be registered on Launchpad
-and pushed to. The easiest way to create a branch to work from is to run:
-`bzr branch lp:entertainer <your branch name here>`
-
-The bug or feature is then developed.  In order for a branch to be complete,
-and ready to merge, it must have sufficient tests, pass all of the tests in the
-test suite, and passes all lint tests.  The latter two criteria can be checked
-by typing `make check` in the branch's top level directory.
-
-When you feel your branch is ready, you'll submit a branch merge proposal in
-Launchpad, where your branch should be reviewed by at least two developers.
-Please be sure to submit review requests to two core developers who you believe
-will be able to review your code. Once it is reviewed and signed off, a member
-of the Entertainer Release team will merge your branch into trunk.
-
-== Design and Documentation ==
-
 When adding a new feature or fixing a large bug, unless it is less than five
 lines, please make it known on the Entertainer Developers Mailing List and
 give us some details on your implementation. This way, discussion can take
@@ -102,20 +31,99 @@
 trunk without documentation, please be prepared when your change is
 removed from the trunk, pending documentation.
 
-== Coding Styles ==
+When a bug or feature is to be implemented, a branch of
+lp:~entertainer-releases/entertainer/devel is created. Once it is branched, it
+needs to be registered on Launchpad and pushed to. The easiest way to create
+a branch to work from is to run:
+
+``bzr branch lp:entertainer <your branch name here>``
+
+The bug or feature is then developed.  In order for a branch to be complete,
+and ready to merge, it must have sufficient tests, pass all of the tests in the
+test suite, and passes all lint tests.  The latter two criteria can be checked
+by typing `make check` in the branch's top level directory.
+
+When you feel your branch is ready, you'll submit a branch merge proposal in
+Launchpad, where your branch should be reviewed by a member of the Entertainer
+Releases team. Please be sure to submit review requests to two core developers
+who you believe will be able to review your code. Once it is reviewed and
+signed off, a member of the Entertainer Release team will merge your branch
+into trunk.
+
+
+Bug Workflow
+============
+
+The following information describes how Entertainer uses Launchpad's bug
+system.
+
+**New Bugs** Bugs from regular users will always come in with a status
+of New and Undecided. Entertainer developers have the ability to set new bugs
+to have some status other than New and Undecided, but we try to adopt a policy
+of letting other developers confirm our bugs (this is a way to keep us
+accountable and to ensure that the bug is, in fact, true for others too).
+
+**Information Audit** If someone else wrote the bug, we check it to see what
+kind of information it has. It may have tracebacks, but sometimes reporters
+don't give us useful stuff. If that is the case, we request more information
+(like the log file in ~/.config/entertainer) and mark it "Incomplete" and
+leave the priority Undecided.
+
+**Bug Triage** If you see a new bug, and can verify it, but have no idea how
+it should be fixed, it should be marked as "Confirmed". If you can provide
+extra new information that might help someone else figure out the problem,
+please add that to the bug. You may mark the priority at this time if you
+have a good feeling for what it should be.
+
+If you see a new bug, and can verify it, and you have a good idea about
+where/how the bug can be fixed, mark it as "Triaged". At this time, use your
+best judgment about setting the priority. You can see from our bug page that
+most of the bugs are in the Triaged state (we just don't have the manpower to
+handle them all).
+
+**Accepting Work** From the list of Triaged bugs, you would assign yourself
+work (or potentially assign someone else work). For example, problems with
+the RSS feeds are typically assigned to Josh Scotton since he was the initial
+developer of that functionality. For bugs that you're actually working on,
+you should assign yourself the bug, and change the state to "In Progress".
+If you're not going to work the bug yet, leave the state as "Triaged."
+
+If you are working on a bug, but then find you won't be able to fix it, and
+abandon the effort, please make sure to set the bug from "In Progress" to
+"Triaged" and leave any notes that might help the next bug squisher in their
+quest to fix the bug.
+
+**Fix the bug**At this point, the bug flow basically halts while you work on
+your branches in Bazaar. We recommend that you create specific branches and
+link them to bugs that you are fixing. A good rule of thumb is one branch per
+bug, but this is not set in stone. You write your code, go through the merge
+proposal review process, and your code gets committed to the trunk.
+
+**Fix Lands in Trunk** Now, either you (the developer who was working the bug)
+or a member of the Release Team will set the bug to Fix Committed after the
+branch has landed in the trunk. Note: We do NOT mark bugs as Fix Committed
+until they land in the trunk. Everyone's first tendency is to mark a bug as
+Fix Committed as soon as it is done in their branch. Fix Committed does not
+mean "committed to my branch." We want it to mean "committed to the trunk."
+
+**Release!** When we finish the release and make source tarballs and packages
+available, a member of the Release Team will mark all the Fix Committed bugs
+that were in that release as Fix Released.
+
+Coding Styles
+=============
 
 For the most part, Entertainer code adheres to PEP 0008, with a few more
 specifics:
 
-    * Spaces, not tabs
-    * Four spaces to be exact
+    * Spaces, not tabs.
+    * Four spaces to be exact.
     * Maximum line length of 80 characters, unless your code gets more
-      confusing by breaking the line (be prepared to justify this)
-    * No trailing whitespace at the end of a line, or blank lines that contain
-      spaces in them
+      confusing by breaking the line (be prepared to justify this).
+    * No trailing whitespace at the end of a line.
     * Make sure copyright notices are found in EVERY source file
     * If code is "borrowed" from another source, please annotate that. It's
-      just good practice
+      just good practice.
     * Strings that will be displayed to the end-user must be wrapped like this
       _("Example String") this is so it is picked up to be translated.
     * Formatted strings such as "Track %s of %s" % (number, total) that need
@@ -123,13 +131,18 @@
       _("Track %(track)s of %(album)s") % {'track': number, 'album': total}
     * Docstrings are written compliant with PEP 0257
 
-== Debugging ==
+
+Tips and Tricks
+===============
+
+**Debugging**
 
 Paul Hummer wrote a blog post on the best practices for working with the pdb
 debugger, specifically based on his experience using it with Entertainer.  It
-can be found at http://theironlion.net/blog/howto-python-debugging-pdb/
+can be found at `http://theironlion.net/archive/howto-python-debugging-pdb/
+<http://theironlion.net/archive/howto-python-debugging-pdb/>`_
 
-== Testing ==
+**Testing**
 
 When starting development, please stop off at src/tests and write a unittest
 for the feature to be implemented (yes, before developing the feature), or add
@@ -138,47 +151,43 @@
 and helps maintain quality code for Entertainer.
 
 Here is an example unit test, using python's built in unittest module:
------------------------------------------------------------------------
-import os
-import unittest
-
-class TestFoo(unittest.TestCase):
-
-    def setUp(self):
-        '''setUp is for any preliminary things that need to be done
-        prior to actually running the tests, like instantiating objects
-        and database test fixtures'''
-        self.fh = open('foo.file', 'wb')
-        self.foo_to_test = Foo(fh)
-
-    def testDoStuff(self):
-        self.foo_to_test.doStuff()
-        self.assertTrue(self.foo_to_test.didStuff)
-
-    def tearDown(self):
-        '''tearDown is the method called after all tests are run, and
-        is used for clean up from anything generated by setUp'''
-        self.foo_to_test.close()
-        self.fh.close()
-        os.remove('foo.file')
------------------------------------------------------------------------
+
+    import os
+    import unittest
+
+    class TestFoo(unittest.TestCase):
+
+        def setUp(self):
+            '''setUp is for any preliminary things that need to be done
+            prior to actually running the tests, like instantiating objects
+            and database test fixtures'''
+            self.fh = open('foo.file', 'wb')
+            self.foo_to_test = Foo(fh)
+
+        def testDoStuff(self):
+            self.foo_to_test.doStuff()
+            self.assertTrue(self.foo_to_test.didStuff)
+
+        def tearDown(self):
+            '''tearDown is the method called after all tests are run, and
+            is used for clean up from anything generated by setUp'''
+            self.foo_to_test.close()
+            self.fh.close()
+            os.remove('foo.file')
+
 
 There are a few things that need to be pointed out. First, the test should
 always inherit from unittest.TestCase?. The run_tests.py script looks for
-tests that inherit from unittest.TestCase? and runs those tests. Second, the
+tests that inherit from ``unittest.TestCase`` and runs those tests. Second, the
 test never prints anything to stdout or stderr. If the test needs to log to a
 file, that is fine, but please don't print anything to stdout or stderr.
 Lastly, the tearDown removed a file that was created by the test (and is not
 checked into svn).
 
-After the test is written, please run run_tests.py in the src/tests folder,
-and make sure the test is failing correctly before moving on to development.
-
-For more information about the unittest module, and how to use it, please see:
-
-    * http://docs.python.org/lib/module-unittest.html
-    * http://docs.python.org/lib/doctest-unittest-api.html
-    * http://agiletesting.blogspot.com/2005/01/python-unit-testing-part-1-unittest.html
-    * http://www.onlamp.com/pub/a/python/2004/12/02/tdd_pyunit.html
-    * ...or pretty much anything Grig Gheoghiu or Titus Brown have to say about testing...
+After the test is written, run the test and make sure the test is failing
+correctly before moving on to development.  To run the whole test suite, run
+``make check`` in the root of the branch.  To run a single test, you can use
+trial.  For instance, to run all the music tests, you'd use
+``trial entertainerlib.tests.test_music``.
+
 

=== removed file 'docs/LICENSE'
--- docs/LICENSE	2008-06-25 02:15:19 +0000
+++ docs/LICENSE	1970-01-01 00:00:00 +0000
@@ -1,339 +0,0 @@
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 2, June 1991
-
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-			    Preamble
-
-  The licenses for most software are designed to take away your
-freedom to share and change it.  By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users.  This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it.  (Some other Free Software Foundation software is covered by
-the GNU Lesser General Public License instead.)  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
-  To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have.  You must make sure that they, too, receive or can get the
-source code.  And you must show them these terms so they know their
-rights.
-
-  We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
-  Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software.  If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
-  Finally, any free program is threatened constantly by software
-patents.  We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary.  To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-		    GNU GENERAL PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-  0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License.  The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language.  (Hereinafter, translation is included without limitation in
-the term "modification".)  Each licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope.  The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
-  1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
-  2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
-    a) You must cause the modified files to carry prominent notices
-    stating that you changed the files and the date of any change.
-
-    b) You must cause any work that you distribute or publish, that in
-    whole or in part contains or is derived from the Program or any
-    part thereof, to be licensed as a whole at no charge to all third
-    parties under the terms of this License.
-
-    c) If the modified program normally reads commands interactively
-    when run, you must cause it, when started running for such
-    interactive use in the most ordinary way, to print or display an
-    announcement including an appropriate copyright notice and a
-    notice that there is no warranty (or else, saying that you provide
-    a warranty) and that users may redistribute the program under
-    these conditions, and telling the user how to view a copy of this
-    License.  (Exception: if the Program itself is interactive but
-    does not normally print such an announcement, your work based on
-    the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole.  If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works.  But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-  3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
-    a) Accompany it with the complete corresponding machine-readable
-    source code, which must be distributed under the terms of Sections
-    1 and 2 above on a medium customarily used for software interchange; or,
-
-    b) Accompany it with a written offer, valid for at least three
-    years, to give any third party, for a charge no more than your
-    cost of physically performing source distribution, a complete
-    machine-readable copy of the corresponding source code, to be
-    distributed under the terms of Sections 1 and 2 above on a medium
-    customarily used for software interchange; or,
-
-    c) Accompany it with the information you received as to the offer
-    to distribute corresponding source code.  (This alternative is
-    allowed only for noncommercial distribution and only if you
-    received the program in object code or executable form with such
-    an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it.  For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable.  However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-  4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License.  Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-  5. You are not required to accept this License, since you have not
-signed it.  However, nothing else grants you permission to modify or
-distribute the Program or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
-  6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
-  7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-  8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded.  In such case, this License incorporates
-the limitation as if written in the body of this License.
-
-  9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number.  If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation.  If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
-  10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission.  For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this.  Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
-			    NO WARRANTY
-
-  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
-  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
-		     END OF TERMS AND CONDITIONS
-
-	    How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License along
-    with this program; if not, write to the Free Software Foundation, Inc.,
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
-    Gnomovision version 69, Copyright (C) year name of author
-    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
-  `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
-  <signature of Ty Coon>, 1 April 1989
-  Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs.  If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.

=== removed file 'docs/backend_core.tex'
--- docs/backend_core.tex	2008-12-14 19:58:40 +0000
+++ docs/backend_core.tex	1970-01-01 00:00:00 +0000
@@ -1,25 +0,0 @@
-Backend uses \emph{message-bus architecure}. Core of the backend consists of
-\emph{message bus}, \emph{messages}, \emph{message scheduler}, \emph{connection server} and \emph{message bus proxy}. All components of the backend are registered to message bus. Backend components communicate with each other by sending messages to the message bus. Also client processes can register them selves to the message bus via message-bus proxy. This way clients can trasparently communicate with backend components. Behind the curtains this communication is implemented using sockets, but clients doesn't need to know that. All they know is that they can send and receive messages. Figure \ref{fig:backend_arch} illustrates the architecture with a high level diagram. In the following sections we dicuss each component in more detail.
-
-\begin{figure}[htb]
-	\begin{center}
-		\includegraphics[angle=0,scale=0.4]{diagrams/Backend/high_level.png}
-		\caption{Backend architecure}
-		\label{fig:backend_arch}
-	\end{center}
-\end{figure}
-
-\subsubsection{Message bus}
-Message bus is an object (type of \texttt{MessageBus}) that is resposible of transmitting messages between registered components. Every component has to implement \texttt{MessageHandler} interface so that it can receive messages properly. \texttt{MessageBus} has more also more advanced features than just trasmitting messages to all components. Every component has to determine message types that it is interested in. Components also determine the priority level for each message type. This way \texttt{MessageBus} doesn't have to transmit all messages to all components. Instead, it notifies only those components that are really interested in some particular message type. For more, \texttt{MessageBus} notifies those components in the order of priorites. For example, it is more critical to start recording as soon as possible than display notification bubble that recording has been started. That's why DVB-recorder tells the \texttt{MessageBus} that it has \texttt{VERY\_HIGH} priori
 ty for \texttt{START\_RECORDING} message type and similary notification system says that it has \texttt{VERY\_LOW} priority. Now, when \texttt{START\_RECORDING} message occurs, the \texttt{MessageBus} knows that it should first notify DVB-recorder and after that notification system. MessageBus is locked in such a way that only one message can occur at the time on the bus.
-
-\subsubsection{Message}
-Message is an object of \texttt{Message} type. These are the objects that are transmitted via \texttt{MessageBus}. Each Message has a message type and possibly some user data. Data part can contain arbitary data or it can be empty. Message types are defined in \texttt{MessageType} class. I suggest to take a look of that class, because it provides more information about the meaning of different message types. When component wants to send a \texttt{Message} to the \texttt{MessageBus} it needs to create a Message object and after that call \texttt{MessageBus}-object's \texttt{notifyMessage(message\_obj)} method.
-
-\subsubsection{Message scheduler}
-\texttt{MessageScheduler} object generates messages to the message bus. When backend starts, it registers message types and intervals to the \texttt{MessageScheduler}. After that messages are generated to the message bus in given time intervals. When message types are registered to the \texttt{MessageScheduler}, it creates a random time interval for each message type. This prevents all messages to be generated at the same time to the message bus. Random time interval is waited only the first time. After this messages are generated with given time interval. This scheduler is used for updateing guide and feed cache every now and then. It is also easy to add new features that require frequent updates.
-
-\subsubsection{Connection server}
-\texttt{ConnectionServer} listens incoming client connections and binds connected clients to the MessageBus. Every client is handled in it's own thread. This class is strictly binded to the MessageBusProxy class which we will discuss in next section.
-
-\subsubsection{Message bus proxy}
-\texttt{MessageBusProxy} object hides the complexity of sockets. \texttt{MessageBusProxy} is used in client process (Frontend for example) and it is abstraction of backend's \texttt{MessageBus}. In other words, client processes can act like backend components simply by using object of this class. This makes communication between components very easy no matter in which process the components are actually running.

=== removed file 'docs/cache.tex'
--- docs/cache.tex	2008-12-14 19:58:40 +0000
+++ docs/cache.tex	1970-01-01 00:00:00 +0000
@@ -1,79 +0,0 @@
-Entertainer has a cache almost for every data type that it handles including
-images, videos, music, feeds, tv-guide and recordings. All caches are
-implemented as SQLite databases. Every cache is stored in it's own file that
-has \texttt{db} extension. Caches are stored in the following directory:
-\texttt{$\sim$/.entertainer/cache}.
-
-\subsection{Descriptions}
-
-\subsubsection{Image cache}
-Image cache contains all information of the images. It has two tables:
-\texttt{Image} and \texttt{Album}. Album has a title and description and it
-contains images. Image table contains information on images. One row matches
-to one file. Entertainer considers folder as an album and images in that folder
-belog to that album. Subfolder are own albums and there is no deep hierarcy in
-image cache. In figure \ref{fig:image_er} is ER-diagram of the image cache database.
-This database is stored in \texttt{$\sim$/.entertainer/cache/image.db}.
-
-\subsubsection{Music cache}
-Music cache contains everything related to the music library. Entertainer's
-music library contains Albums, Tracks, Artists and Playlists. All this data
-is stored in music cache database, which is stored in 
-\texttt{$\sim$/.entertainer/cache/music.db} -file. In figure \ref{fig:music_er}
-you can see the structure of the cache. As you can see, there is only \texttt{Track}
-and \texttt{Playlist} tables. MusicLibrary handels the abstraction of albums and
-artists. This cache is created in \texttt{backend/components/mediacache/music\_cache.py}.
-
-\subsubsection{Video cache}
-Video cache contains information on video files. These do NOT include recorded
-TV-shows, but only the files that are in video library. Video cache contains two
-tabels \texttt{videofile} and \texttt{metadata} (actually these should be merged).
-\texttt{Videofile} table contains basic information on video and \texttt{metadata} 
-some extrnal information. Metadata table contains type field, which determinse
-the type of the videofile. Allowed values are \texttt{MOVIE}, \texttt{CLIP} and 
-\texttt{TV-SERIES}. According to this field the video is represnted as a 
-\texttt{Movie}, \texttt{TVEpisode} or \texttt{VideoClip} object in VideoLibrary 
-(client side). This cache database is stored in \texttt{$\sim$/.entertainer/cache/video.db}.
-In figure \ref{fig:video_er}
-
-\subsubsection{Feed cache}
-Feed cache includes all feeds and entries of those feeds. Entry is a one ''post''
-of the feed. Backend fetches feeds time to time and updates the cache. Cache keeps
-up to 50 entries per feed. In figure \ref{fig:feed_er} you can see the structure
-of the Feed cache. Cache is stored in \texttt{$\sim$/.entertainer/cache/feed.db}
-
-\subsection{ER-diagrams}
-\begin{comment}
-
-\begin{figure}[htb]
-	\begin{center}
-		\includegraphics[angle=0,scale=0.6]{diagrams/ER/image_library_er.png}
-		\caption{ER-diagram of the image cache.}
-		\label{fig:image_er}
-	\end{center}
-\end{figure}
-
-\begin{figure}[htb]
-	\begin{center}
-		\includegraphics[angle=0,scale=0.6]{diagrams/ER/music_library_er.png}
-		\caption{ER-diagram of the music cache.}
-		\label{fig:music_er}
-	\end{center}
-\end{figure}
-
-\begin{figure}[htb]
-	\begin{center}
-		\includegraphics[angle=0,scale=0.6]{diagrams/ER/feed_library_er.png}
-		\caption{ER-diagram of the video cache.}
-		\label{fig:video_er}
-	\end{center}
-\end{figure}
-
-\begin{figure}[htb]
-	\begin{center}
-		\includegraphics[angle=0,scale=0.6]{diagrams/ER/feed_library_er.png}
-		\caption{ER-diagram of the feed cache.}
-		\label{fig:feed_er}
-	\end{center}
-\end{figure}
-\end{comment}

=== removed file 'docs/components.tex'
--- docs/components.tex	2008-12-14 19:58:40 +0000
+++ docs/components.tex	1970-01-01 00:00:00 +0000
@@ -1,8 +0,0 @@
-\subsubsection{System tray icon}
-(Partly depricated information) System tray icon is a small icon that is usually displayed in notification area. \texttt{SystemTrayIcon} class implements this icon and it's pop-up menu, which allows user to manage Entertainer media center. Pop-up menu contains Log viewer, which can be used to see Entertainer's log. It also allowes easy way to execute configuration GUIs and frontend process. SystemTrayIcon class implements MessageHandler and it is interested of messages \texttt{RECORDING\_STARTED} and \texttt{RECORDING\_STOPPED}. When Entertainer is recording a TV-show the system tray icon changes to the recording icon. This way user can easily see that Entertainer is currently recording.
-
-\subsubsection{Notification system}
-Notification system displays notification bubbels on the desktop. Notification system is implemented with \texttt{Notify} class that uses \emph{libnotify} library. Notification bubbles are displayed when Entertainer backend begins or ends recording and also if there are conflicts between scheduled recordings. It's easy to add new notifications by modifying the \texttt{Notify} class. \texttt{Notify} implements \texttt{MessageHandler} and it's registered to the message bus when backend starts.
-
-\subsubsection{Feed manager}
-Feed manager is responsible of updateing feed cache. At the moment, only RSS-feeds are supported. \texttt{FeedManager} and \texttt{FeedFetcher} classes implements this feature. \texttt{FeedManager} implements \texttt{MessageHandler} interface and it is registered to the message bus. When \texttt{FeedManager} receives \texttt{UPDATE\_FEEDS} message, it executes a new \texttt{FeedFetcher} thread that does the actually cache updating. When update is done, \texttt{FEED\_CACHE\_UPDATED} message is emitted to the message bus.

=== removed file 'docs/content_management_gui.tex'
--- docs/content_management_gui.tex	2008-12-14 19:58:40 +0000
+++ docs/content_management_gui.tex	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-Content Management GUI is exactly like Preferences GUI, but it is used to manage content of the Entertainer. This GUI application allows user to add and remove content of the Entertainer easily. Content Management GUI edits the \texttt{/.entertainer/content.cfg} -file and also notifies the backend when changes occur. Just like the Preferences GUI.

=== removed file 'docs/developer_documentation.aux'
--- docs/developer_documentation.aux	2008-12-14 19:58:40 +0000
+++ docs/developer_documentation.aux	1970-01-01 00:00:00 +0000
@@ -1,38 +0,0 @@
-\relax 
-\select@language{english}
-\@writefile{toc}{\select@language{english}}
-\@writefile{lof}{\select@language{english}}
-\@writefile{lot}{\select@language{english}}
-\@writefile{toc}{\contentsline {section}{\numberline {1}INTRODUCTION}{1}}
-\@writefile{toc}{\contentsline {section}{\numberline {2}HIGH LEVEL ARCHITECTURE}{2}}
-\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces High-level architecure}}{2}}
-\newlabel{fig:high_level_arch}{{1}{2}}
-\@writefile{toc}{\contentsline {section}{\numberline {3}CACHE}{4}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}Descriptions}{4}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.1}Image cache}{4}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.2}Music cache}{4}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.3}Video cache}{5}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4}Feed cache}{5}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}ER-diagrams}{5}}
-\@writefile{toc}{\contentsline {section}{\numberline {4}BACKEND}{6}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {4.1}Core}{6}}
-\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces Backend architecure}}{6}}
-\newlabel{fig:backend_arch}{{2}{6}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.1}Message bus}{7}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.2}Message}{7}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.3}Message scheduler}{7}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.4}Connection server}{8}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.1.5}Message bus proxy}{8}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {4.2}Components}{8}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.1}System tray icon}{8}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2}Notification system}{9}}
-\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.3}Feed manager}{9}}
-\@writefile{toc}{\contentsline {section}{\numberline {5}FRONTEND}{10}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {5.1}Architecture}{10}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {5.2}Graphical User Interface}{10}}
-\@writefile{lof}{\contentsline {figure}{\numberline {3}{\ignorespaces Entertainer GUI layers.}}{11}}
-\newlabel{fig:layers}{{3}{11}}
-\@writefile{toc}{\contentsline {section}{\numberline {6}EXTRA TOOLS FOR ENTERTAINER}{13}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {6.1}Preferences GUI}{13}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {6.2}Content management GUI}{13}}
-\@writefile{toc}{\contentsline {subsection}{\numberline {6.3}Message bus notifier}{13}}

=== removed file 'docs/developer_documentation.tex'
--- docs/developer_documentation.tex	2008-12-14 19:58:40 +0000
+++ docs/developer_documentation.tex	1970-01-01 00:00:00 +0000
@@ -1,94 +0,0 @@
-\documentclass[12pt,a4paper]{article}
-\usepackage[utf8]{inputenc}
-\usepackage[english]{babel}
-
-\usepackage{graphicx}
-\usepackage{verbatim}
-\usepackage{cite}
-
-% Marginal (left/right)
-\setlength{\hoffset}{0mm}
-\setlength{\marginparsep}{0mm}
-\setlength{\marginparwidth}{0mm}
-\setlength{\textwidth}{\paperwidth}
-\addtolength\textwidth{-60 mm}
-\setlength{\oddsidemargin}{-1 in}
-\addtolength\oddsidemargin{40 mm}
-
-% Marginal (top/down)
-\setlength{\voffset}{0 mm}
-\setlength{\topmargin}{0 mm}
-\setlength{\headheight}{12 pt}
-\setlength{\headsep}{24 pt}
-\setlength{\textheight}{230mm}
-\setlength{\footnotesep}{12 pt}
-
-\setlength{\parindent}{0pt}
-\setlength{\parskip}{0.05cm}
-\linespread{1.3}
-
-\title{Entertainer - Developer's documentation}
-\author{Lauri Taimila}
-\date{05/27/2007}
-
-\begin{document}
-
-    % Cover page
-    \pagestyle{empty}
-    \maketitle
-    \pagebreak
-
-	% Page numbering for contents
-	\setcounter{page}{1}
-    \pagestyle{plain}
-    \markright{Latex-dokumentti}
-    \pagenumbering{roman}
-	
-	\renewcommand{\baselinestretch}{1.2}
-	\tableofcontents
-	\pagebreak
-
-	% Start page numbering from Introduction page
-	\newpage
-    \setcounter{page}{1}
-    \pagenumbering{arabic}
-    \pagestyle{plain}
-	
-	\renewcommand{\baselinestretch}{1.655}
-	\setlength{\parskip}{0.7cm plus3mm minus3mm}
-	
-	\section{INTRODUCTION}
-	\input{introduction.tex}
-	\newpage
-	
-	\section{HIGH LEVEL ARCHITECTURE}
-	\input{high_level_architecture.tex}
-    \newpage
-    
-	\section{CACHE}
-	\input{cache.tex}
-	\newpage
-	
-	\section{BACKEND}
-    	\subsection{Core}
-    	\input{backend_core.tex}
-    	\subsection{Components}
-    	\input{components.tex}
-    	
-    \newpage
-	\section{FRONTEND}
-	    \subsection{Architecture}
-	    \input{frontend_architecture.tex}
-	    \subsection{Graphical User Interface}
-	    \input{gui.tex}
-	
-	\newpage
-	\section{EXTRA TOOLS FOR ENTERTAINER}
-    	\subsection{Preferences GUI}
-    	\input{preferences_gui.tex}
-    	\subsection{Content management GUI}
-    	\input{content_management_gui.tex}
-    	\subsection{Message bus notifier}
-    	\input{message_bus_notifier.tex}
-\end{document}
-

=== removed file 'docs/developer_documentation.toc'
--- docs/developer_documentation.toc	2008-12-14 19:58:40 +0000
+++ docs/developer_documentation.toc	1970-01-01 00:00:00 +0000
@@ -1,28 +0,0 @@
-\select@language {english}
-\contentsline {section}{\numberline {1}INTRODUCTION}{1}
-\contentsline {section}{\numberline {2}HIGH LEVEL ARCHITECTURE}{2}
-\contentsline {section}{\numberline {3}CACHE}{4}
-\contentsline {subsection}{\numberline {3.1}Descriptions}{4}
-\contentsline {subsubsection}{\numberline {3.1.1}Image cache}{4}
-\contentsline {subsubsection}{\numberline {3.1.2}Music cache}{4}
-\contentsline {subsubsection}{\numberline {3.1.3}Video cache}{5}
-\contentsline {subsubsection}{\numberline {3.1.4}Feed cache}{5}
-\contentsline {subsection}{\numberline {3.2}ER-diagrams}{5}
-\contentsline {section}{\numberline {4}BACKEND}{6}
-\contentsline {subsection}{\numberline {4.1}Core}{6}
-\contentsline {subsubsection}{\numberline {4.1.1}Message bus}{7}
-\contentsline {subsubsection}{\numberline {4.1.2}Message}{7}
-\contentsline {subsubsection}{\numberline {4.1.3}Message scheduler}{7}
-\contentsline {subsubsection}{\numberline {4.1.4}Connection server}{8}
-\contentsline {subsubsection}{\numberline {4.1.5}Message bus proxy}{8}
-\contentsline {subsection}{\numberline {4.2}Components}{8}
-\contentsline {subsubsection}{\numberline {4.2.1}System tray icon}{8}
-\contentsline {subsubsection}{\numberline {4.2.2}Notification system}{9}
-\contentsline {subsubsection}{\numberline {4.2.3}Feed manager}{9}
-\contentsline {section}{\numberline {5}FRONTEND}{10}
-\contentsline {subsection}{\numberline {5.1}Architecture}{10}
-\contentsline {subsection}{\numberline {5.2}Graphical User Interface}{10}
-\contentsline {section}{\numberline {6}EXTRA TOOLS FOR ENTERTAINER}{13}
-\contentsline {subsection}{\numberline {6.1}Preferences GUI}{13}
-\contentsline {subsection}{\numberline {6.2}Content management GUI}{13}
-\contentsline {subsection}{\numberline {6.3}Message bus notifier}{13}

=== removed directory 'docs/diagrams'
=== removed directory 'docs/diagrams/Backend'
=== removed file 'docs/diagrams/Backend/Backend_classes_in_detail.dia'
Binary files docs/diagrams/Backend/Backend_classes_in_detail.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/Backend_classes_in_detail.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/Backend_classes_in_detail.png'
Binary files docs/diagrams/Backend/Backend_classes_in_detail.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/Backend_classes_in_detail.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/backend_class_diagram.dia'
Binary files docs/diagrams/Backend/backend_class_diagram.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/backend_class_diagram.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/backend_class_diagram.png'
Binary files docs/diagrams/Backend/backend_class_diagram.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/backend_class_diagram.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/backend_class_diagram_new.dia'
Binary files docs/diagrams/Backend/backend_class_diagram_new.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/backend_class_diagram_new.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/backend_class_diagram_new.png'
Binary files docs/diagrams/Backend/backend_class_diagram_new.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/backend_class_diagram_new.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/backend_hi_level_arch.dia'
Binary files docs/diagrams/Backend/backend_hi_level_arch.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/backend_hi_level_arch.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/high_level.png'
Binary files docs/diagrams/Backend/high_level.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/high_level.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/image_cache_sequece_diagram.dia'
Binary files docs/diagrams/Backend/image_cache_sequece_diagram.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/image_cache_sequece_diagram.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/image_cache_sequece_diagram.png'
Binary files docs/diagrams/Backend/image_cache_sequece_diagram.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/image_cache_sequece_diagram.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/media_indexer_class_diagram.dia'
Binary files docs/diagrams/Backend/media_indexer_class_diagram.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/media_indexer_class_diagram.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Backend/media_indexer_class_diagram.png'
Binary files docs/diagrams/Backend/media_indexer_class_diagram.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Backend/media_indexer_class_diagram.png	1970-01-01 00:00:00 +0000 differ
=== removed directory 'docs/diagrams/ER'
=== removed file 'docs/diagrams/ER/feed_library_er.dia'
Binary files docs/diagrams/ER/feed_library_er.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/ER/feed_library_er.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/ER/feed_library_er.png'
Binary files docs/diagrams/ER/feed_library_er.png	2008-12-14 19:58:40 +0000 and docs/diagrams/ER/feed_library_er.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/ER/image_library_er.dia'
Binary files docs/diagrams/ER/image_library_er.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/ER/image_library_er.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/ER/image_library_er.png'
Binary files docs/diagrams/ER/image_library_er.png	2008-12-14 19:58:40 +0000 and docs/diagrams/ER/image_library_er.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/ER/music_library_er.dia'
Binary files docs/diagrams/ER/music_library_er.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/ER/music_library_er.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/ER/music_library_er.png'
Binary files docs/diagrams/ER/music_library_er.png	2008-12-14 19:58:40 +0000 and docs/diagrams/ER/music_library_er.png	1970-01-01 00:00:00 +0000 differ
=== removed directory 'docs/diagrams/Frontend'
=== removed file 'docs/diagrams/Frontend/frontend_class_diagram.dia'
Binary files docs/diagrams/Frontend/frontend_class_diagram.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/frontend_class_diagram.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/frontend_class_diagram.png'
Binary files docs/diagrams/Frontend/frontend_class_diagram.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/frontend_class_diagram.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/frontend_class_diagram_high.dia'
Binary files docs/diagrams/Frontend/frontend_class_diagram_high.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/frontend_class_diagram_high.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/frontend_class_diagram_high.png'
Binary files docs/diagrams/Frontend/frontend_class_diagram_high.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/frontend_class_diagram_high.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/gui.dia'
Binary files docs/diagrams/Frontend/gui.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/gui.dia	1970-01-01 00:00:00 +0000 differ
=== removed directory 'docs/diagrams/Frontend/medialibrary'
=== removed file 'docs/diagrams/Frontend/medialibrary/feed_library.dia'
Binary files docs/diagrams/Frontend/medialibrary/feed_library.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/medialibrary/feed_library.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/medialibrary/feed_library.png'
Binary files docs/diagrams/Frontend/medialibrary/feed_library.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/medialibrary/feed_library.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/medialibrary/image_library.dia'
Binary files docs/diagrams/Frontend/medialibrary/image_library.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/medialibrary/image_library.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/medialibrary/image_library.png'
Binary files docs/diagrams/Frontend/medialibrary/image_library.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/medialibrary/image_library.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/medialibrary/music_library.dia'
Binary files docs/diagrams/Frontend/medialibrary/music_library.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/medialibrary/music_library.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/medialibrary/music_library.png'
Binary files docs/diagrams/Frontend/medialibrary/music_library.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/medialibrary/music_library.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/medialibrary/video_library.dia'
Binary files docs/diagrams/Frontend/medialibrary/video_library.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/medialibrary/video_library.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/medialibrary/video_library.png'
Binary files docs/diagrams/Frontend/medialibrary/video_library.png	2008-12-14 19:58:40 +0000 and docs/diagrams/Frontend/medialibrary/video_library.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/Frontend/weather.dia'
Binary files docs/diagrams/Frontend/weather.dia	2008-03-08 16:42:27 +0000 and docs/diagrams/Frontend/weather.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/gui_layers.png'
Binary files docs/diagrams/gui_layers.png	2008-01-12 22:26:09 +0000 and docs/diagrams/gui_layers.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/high-level-diagram.dia'
Binary files docs/diagrams/high-level-diagram.dia	2008-12-14 19:58:40 +0000 and docs/diagrams/high-level-diagram.dia	1970-01-01 00:00:00 +0000 differ
=== removed file 'docs/diagrams/high-level-diagram.png'
Binary files docs/diagrams/high-level-diagram.png	2008-12-14 19:58:40 +0000 and docs/diagrams/high-level-diagram.png	1970-01-01 00:00:00 +0000 differ
=== added file 'docs/entertainer-depgraph.png'
Binary files docs/entertainer-depgraph.png	1970-01-01 00:00:00 +0000 and docs/entertainer-depgraph.png	2009-02-01 19:35:11 +0000 differ
=== renamed file 'docs/entertainer.1.gz' => 'docs/entertainer.1'
Binary files docs/entertainer.1.gz	2008-12-16 03:37:47 +0000 and docs/entertainer.1	2009-02-01 06:12:43 +0000 differ
=== removed file 'docs/frontend_architecture.tex'
--- docs/frontend_architecture.tex	2008-01-12 22:26:09 +0000
+++ docs/frontend_architecture.tex	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-Not written yet...

=== removed file 'docs/gui.tex'
--- docs/gui.tex	2008-01-12 22:26:09 +0000
+++ docs/gui.tex	1970-01-01 00:00:00 +0000
@@ -1,68 +0,0 @@
-Graphical user interface is one of the most important parts of the Media Center
-application. Entertainer user interface is implemented with Clutter and GTK. Frontend
-consists of GTK-window that contains toolbar, menu bar, status bar and the most
-important part ,\textit{Clutter stage}, which is displayed via Clutter-GTK widget.
-Frontend also includes preferences dialog, content management dialog and log viewer.
-All these three sub components can be also executed as separated processes without
-executing the whole frontend. These dialogs are discussed more depth in chapter 6.
-
-In this chapter we concentrate to the Clutter part of the GUI. The main class of 
-the GUI is \textit{UserInterface} that is responsible of managing screen changes 
-and creating all screens. \textit{UserInterface} object also receives all user 
-actions. When key press is received, UserInterface object method \texttt{handle\_key\_press\_event()}
-is called. This method decides how to react to key press action. Usually it just
-forwards event to the current screen. Current screen has internal logic for events.
-
-\subsubsection*{Entertainer UI layers}
-Entertainer UI can be thinked as a set of layers that are piled on to each other.
-This screen stack is illustrated in the figure \ref{fig:layers}.
-
-\begin{figure}[htb]
-	\begin{center}
-		\includegraphics[angle=0,scale=0.7]{diagrams/gui_layers.png}
-		\caption{Entertainer GUI layers.}
-		\label{fig:layers}
-	\end{center}
-\end{figure}
-
-Figure above shows how video is always displayd under menu overlay and screen
-widgets. If video is not running the whole layer doesn't exists. In this case
-the background layer is displayed through menu overlay image. If current screen
-is OSD type, then menu overlay layer is hidden. This way OSD screens allow user
-to see video playback on screen as it should be seen. Menu overlay layer is drawn
-only when user is navigating in menus. This figure omits the possibility of two
-screens to be displayed at the same time. This happends when another screen is
-type of DIALOG. Dialogs are shown on top of the current screen.
-
-\subsubsection*{Screen life cycle}
-Entertainer has two important concepts: \textit{Screen} and \textit{Transition}. 
-These both are also interfaces that many classes implement. Screen is a set of 
-Clutter actors, which together create one view. View is what users sees on screen.
-Transition is a mechanism to animate screen switches. Say, when user selects
-photo album from the photo album list, we need to switch from the photo screen 
-to the album screen. When this happens. We call UserInterface objects's c\texttt{hangeScreen()}.
-This call creates a new screen (in this case album screen) and then gives current
-screen and new screen to the Transition object, which animates screen switch.
-
-Screen is created when it is needed, in other words, when user enters to that screen.
-When screen object is created it is added to the Clutter stage object. It's also
-pushed into the \textit{Screen history}, which is a stack of Screen objects. 
-\texttt{ScreenHistory} object keeps record of recent screens. This allows user
-to navigate "back" just like in web-browsers. History size can be changed from
-the preferences dialog. Screen is added to the stage when it is created, but
-when we remove it? There are two possibilites: When history size is exceeded the
-oldest screen is removed. Also when user navigates to "back", the current screen
-is NOT added into the history and it is removed from stage immediately. If we would
-add screens into the history when navigating back, then we would create an endless
-loop of two screens.
-
-\subsubsection*{Creating a new Screen or Transition effect}
-If you want to create a new view to the Entertainer, say e-mail reader, you need 
-to write a new \texttt{EmailScreen} class that implements \texttt{Screen} interface. 
-If you want to create a new transition effect you just implement \texttt{Transition} 
-interface which contains only two methods. It's recommended to look into the
- \texttt{FadeTransition} class to get the idea how transitions effects work.
-\textbf{Notice} that if animation direction is "backwards" then you need to
-remove old screen from the stage after animation has been displayed. This can
-be done by using 'completed' signal with Clutter \texttt{Timeline} object.
-

=== removed file 'docs/high_level_architecture.tex'
--- docs/high_level_architecture.tex	2008-12-14 19:58:40 +0000
+++ docs/high_level_architecture.tex	1970-01-01 00:00:00 +0000
@@ -1,13 +0,0 @@
-Entertainer uses client-server achitecture and it has two main components called \emph{frontend} and \emph{backend}. The backend is a daemon (kind of) server process that runs in the background all the time. It is respossible of keeping the \emph{media library cache}, RSS-feeds and TV-Guide up to date and recording scheduled TV-shows. In other words, backend is respossible of everything else, but displaying media on the screen and interacting with the user. Frontend is a GUI part of the application and it displays photographs, plays music and videos. Frontend can be used via remote control and keyboard. Figure \ref{fig:high_level_arch} illustrates the high level architecture of the Entertainer media center application. There are also other processes included to the Entertainer. Those extra processes offer stuff like system tray icon and GTK-interfaces for preferences.
-
-\begin{figure}[htb]
-	\begin{center}
-		\includegraphics[angle=0,scale=0.5]{diagrams/high-level-diagram.png}
-		\caption{High-level architecure}
-		\label{fig:high_level_arch}
-	\end{center}
-\end{figure}
-
-As figure \ref{fig:high_level_arch} shows, the high-level components of the Entertainer are \emph{Frontend}, \emph{Backend}, \emph{Media library Cache} and \emph{Configuration tools}. Backend can communicate with other processes via sockets. Frontend connects to backend when it's executed. It sends simple messages to backend as needed. For example, when user selects a TV-show for recording the frontend sends a message to the backend, which handels the scheduling and recording of the show. Also configration tools notify backend that config files has been changed. This way backend knows to read them again and update it's internal state.
-
-Content can be imagined in between of backend and frontend processes. Backend process indexes files, downloads metadata and generates thumbnails. This activity keeps cache files, which are SQLite databases, up to date. Frontend reads the cache and doesn't care about backend. Backend does also scheduled operations including updating feed cache and guide, which both are SQLite databases as well.

=== removed file 'docs/introduction.tex'
--- docs/introduction.tex	2008-12-14 19:58:40 +0000
+++ docs/introduction.tex	1970-01-01 00:00:00 +0000
@@ -1,7 +0,0 @@
-This document is written for those, who are interested in technical side of the Entertainer Media Center application. Entertainer aims to be a full solution for accessing your multimedia easily via remote control right from your livingroom couch. In this document multimedia refers to music, photographs and videos. Entertainer also includes a private video recorder, which means that Entertainer can be used to watch Live TV and it records your favourite shows for later viewing.
-
-Entertainer is designed to be easily extensible, robust, easy to use and install. The most important keywords of the prject are \emph{simplicity} and \emph{usability}. Media Center application shouldn't require any config file modifications from user. That's why Entertainer provides easy to use GUI-applications for this purpose. Entertainer uses GTK-library for graphical user interface, which means that it's most suitable for GNOME and XFce environments, but it also works on other desktop environments like KDE. Why I chose GTK over QT... well Kentertainer just sounds stupid. ;)
-
-Entertainer uses many existing projects like \texttt{Gstreamer}, \texttt{Clutter}, \texttt{SQLite} and\linebreak\texttt{Universal feed parser} just to name few. Most of the external projects are implemented with C, but Entertainer itself is implemented with a high level language called \emph{Python}. The whole application is implemented strictly in object-oriented manner. This means that everything is modeled as an object.
-
-Entertainer is an open source project released under GPL-licence version 2. This means that you don't have to pay for it and you are allowed to modify the source code and redistribute it under certain limitations. Please, see GPL-licence for more information.

=== removed file 'docs/message_bus_notifier.tex'
--- docs/message_bus_notifier.tex	2008-12-14 19:58:40 +0000
+++ docs/message_bus_notifier.tex	1970-01-01 00:00:00 +0000
@@ -1,12 +0,0 @@
-This is a small command-line application that allows user (or other processes)
-to send messages to the backend's message bus. This was written mainly for debug
-purposes, but it can be used for other things too. The usage of this application
-is straight forward. Command line tool takes only one paramter, which is the
-type of the message that will be emitted to the message bus. Here is an example
-how to force feed cache to be updated immediately:
-\begin{center}
-	\begin{verbatim}
-        entertainer-messagebus-notifier.py --message=UPDATE_FEEDS
-	\end{verbatim}
-\end{center}
-

=== removed file 'docs/preferences_gui.tex'
--- docs/preferences_gui.tex	2008-12-14 19:58:40 +0000
+++ docs/preferences_gui.tex	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-Preferences GUI allows user to configure Entertainer the easy way. Actually it's just a simple GUI for editing \texttt{/.entertainer/preferences.cfg} -configuration file and all the same things can be done with text editor directly. Regardless of this, it is still recommended to use GUI application, because it notifies the backend process that changes has been made. This way backend knows to reload configurations. If changes are made by hand with the text editor, then backend needs to be restarted to changes take effect. Preferences GUI is a standalone application and it can be used even if Entertainer is not running.

=== modified file 'docs/user_guide.tex'
--- docs/user_guide.tex	2008-06-05 15:31:06 +0000
+++ docs/user_guide.tex	2009-02-01 06:24:28 +0000
@@ -15,32 +15,28 @@
 \tableofcontents
 \pagebreak
 \section{Introduction}
-This guide aims to introduce you to the installation and use of the Entertainer Media Center 0.1, the first relase of the program.
-
-As this is an early release of Entertainer you may want certain features added or you may even find some problems (we call them bugs) with the program. If you do, please let us know about them by reporting them at http://bugs.launchpad.net/entertainer.
-
-We've put a lot of work into creating this program and hope that you will enjoy using it.
+This guide aims to introduce you to the installation and use of the Entertainer
+Media Center 0.1, the first relase of the program.
+
+As this is an early release of Entertainer you may want certain features added
+or you may even find some problems (we call them bugs) with the program. If
+you do, please let us know about them by reporting them at
+http://bugs.launchpad.net/entertainer.
+
 \pagebreak
 \part{Installation}
 \section{Ubuntu}
 \index{Ubuntu}
-If you are using Ubuntu Hardy you are in luck as Ubuntu is the easiest linux distribution to install Entertainer on.
-
-Please follow the following steps to install Entertainer on Ubuntu Hardy:
-\begin{enumerate}
- \item \#FIXME Install guide for Hardy goes here
-\end{enumerate}
-
-\section{Other Linux Distributions}
-\#FIXME need some help here
-
-\section{Windows}
-Unfortunately, Entertainer is currently Linux only so no versions will work on Windows.
+For Ubuntu, Entertainer can be installed from the Entertainer-Releases PPA,
+which can be browsed at
+https://edge.launchpad.net/~entertainer-releases/+archive/ppa
 
 \section{From Source}
-If you are really brave you can try installing Entertainer from the development code. You can download this from http://code.launchpad.net/entertainer
+To download the Entertainer source, you can download a tarball from
+http://code.launchpad.net/entertainer
 
-Because the development code can change rapidly as features are added or modified and bugs are fixed, this guide won't be covering installation or using Entertainer from development code. However if you are interested in installating the code please feel free to drop by the \#entertainer IRC channel on irc.freenode.org and we'll do our best to help you.
+To install on other Linux distributions, unpack the tarball and run python
+setup.py install which should install Entertainer.
 
 \pagebreak
 \part{Configuring Entertainer}
@@ -64,7 +60,7 @@
  \item Matt Layman
  \item Joshua Scotton
  \item Jamie Bennett
- \item Micahel Charclo
+ \item Michael Charclo
  \item Blutack (from Launchpad)
  \item Everybody who helped testing and bug reporting...
 \end{itemize}

=== modified file 'setup.py'
--- setup.py	2009-01-26 17:33:36 +0000
+++ setup.py	2009-02-01 06:30:14 +0000
@@ -27,6 +27,8 @@
         log.info("Updating icon cache in %s" % target)
         call(['gtk-update-icon-cache', '-f', '-t', target])
 
+        call(['gzip', '-9', 'docs/entertainer.1'])
+
 def find_files(dirs, dest_root='share'):
     '''Walk files and directories and return them in a form for data_files'''
     # pylint: disable-msg=W0621