~mmcg069/software-center/bug635994-again

878 by Michael Vogt
README: updated, include unittest policy
1
= User notes =
2
3
The software-center application aims to make the software handling on
4
the computer easy and consistent.
5
6
= Developer notes =
7
8
All non UI code must come with tests in the test/ subdirectoy.
5 by Michael Vogt
README:
9
1329 by Michael Vogt
* softwarecenter/db/database.py:
10
== query parser ==
495.2.13 by Michael Vogt
* README:
11
1329 by Michael Vogt
* softwarecenter/db/database.py:
12
The query parser understands :
13
 "pkg:2vcard", "mime:text/html", "section:web", "origin:main"
14
prefixes.
495.2.13 by Michael Vogt
* README:
15
38 by Michael Vogt
README: add information about dbus match limits
16
== aptdaemon ==
17
 * the dbus limits for the system bus are rather low, this means that
18
   adding  <limit name="max_match_rules_per_connection">512</limit> 
19
   and using something bigger than 512 is a good idea
20
1139.1.1 by Michael Vogt
do not set the proxy, as discussed with pitti the system one should be used
21
== environment ==
22
23
The following environment is suported:
1139.1.2 by Michael Vogt
README: add environment that s-c understands
24
25
SOFTWARE_CENTER_USE_GCONF_PROXY - set user proxy instead of using system-wide
1223.2.14 by Michael Vogt
* softwarecenter/app.py,
26
SOFTWARE_CENTER_USE_BUILTIN_LOGIN - use built-in login instead of ubuntu-sso-client
1139.1.2 by Michael Vogt
README: add environment that s-c understands
27
SOFTWARE_CENTER_APPDETAILS_WEBKIT - use the webkit appdetails instead of gtk
28
APPVIEW_DEBUG_TERMS - show debug output for the terms in a search
29
SOFTWARE_CENTER_BUY_HOST - use a alternative hosts to query for pay software
1247.1.40 by Michael Vogt
add SOFTWARE_CENTER_REVIEWS_HOST environment for easy testing, make sure the submit-{review,abuse} ui does not hang while waiting for the network
30
SOFTWARE_CENTER_REVIEWS_HOST - a alternative host for the ratings&reviews
1247.1.95 by Michael Vogt
softwarecenter/backend/rnrclient.py: honor SOFTWARE_CENTER_DEBUG_HTTP in environment
31
SOFTWARE_CENTER_DEBUG_HTTP - enable httplib2 debuging
1139.1.1 by Michael Vogt
do not set the proxy, as discussed with pitti the system one should be used
32
1406.2.1 by Michael Vogt
merged the reviews branch into trunk
33
SOFTWARE_CENTER_IPSUM_REVIEWS - geneate random reviews
1805.1.10 by Aaron Peachey
update some documentation
34
SOFTWARE_CENTER_FAKE_REVIEW_API - use a fake server for all review network operations
1406.2.1 by Michael Vogt
merged the reviews branch into trunk
35
SOFTWARE_CENTER_OLD_PATHBAR - use old pathbar code
36
SOFTWARE_CENTER_SEARCHES_SORT_MODE={popcon,alphabetic,xapian}
37
SOFTWARE_CENTER_GWIBBER_MOCK_USERS=2 - use mock gwibber service
1866 by Michael Vogt
merged lp:~mvo/software-center/piston-sc-agent:
38
SOFTWARE_CENTER_AGENT_INCLUDE_QA - show not yet QA apps available from the agent
1617.2.8 by Matthew McGowan
desensitive action buttons when the netconnection drops
39
SOFTWARE_CENTER_NET_DISCONNECTED - make software-center's netstatus module believe network manager is in a disconnected state
1538.2.9 by Michael Vogt
add SOFTWARE_CENTER_WEBLIVE_HOST environment support
40
SOFTWARE_CENTER_WEBLIVE_HOST - overwrite default weblive server
1884 by Michael Vogt
utils/update-software-center-agent: add debug option --pretend-distro
41
SOFTWARE_CENTER_DISTRO_CODENAME - overwrite "lsb_release -c -s" output
1793 by Michael Vogt
* utils/update-software-center-agent:
42
SOFTWARE_CENTER_NO_SC_AGENT - disable the software-center-agent
1999 by Michael Vogt
add SOFTWARE_CENTER_DEBUG_TABS debug mode
43
SOFTWARE_CENTER_DEBUG_TABS - show notebook tabs for debugging
1139.1.1 by Michael Vogt
do not set the proxy, as discussed with pitti the system one should be used
44
559 by Michael Vogt
* README:
45
== applications.menu ==
46
47
The menu file parser understands:
48
Category, And, Or, Not
49
50
The following additional XML filters are definied:
51
SCType - e.g. "Applicatin"
52
SCChannel - e.g. "lucid-partner"
53
SCSection - e.g. "net"
54
SCPkgname - e.g. "gimp"
55
56
Additional .menu files can be added in:
57
/usr/share/app-install/menu.d 
58
that software-center will read and parse.
38 by Michael Vogt
README: add information about dbus match limits
59
60
== XAPIAN ==
61
5 by Michael Vogt
README:
62
The following special prefixes are used:
63
64
AA - application name (Abiword)
65
AP - package name (abiword)
489 by Michael Vogt
* README:
66
AS - archive pocket (main)
67
AE - archive section (mail, base, ...)
5 by Michael Vogt
README:
68
AC - category (AudioVideo)
1254 by Michael Vogt
* softwarecenter/db/update.py:
69
AM - MimeType (application/x-ogg) 
5 by Michael Vogt
README:
70
AT - type (Application)
126 by Michael Vogt
add desktopfile to the xapian db too
71
AH - channel 
5 by Michael Vogt
README:
72
858.2.35 by Michael Vogt
test/test_reinstall_purchased.py: add test code that builds inmemory db of the already purchased items with a special prefix
73
5 by Michael Vogt
README:
74
The following values are used:
38 by Michael Vogt
README: add information about dbus match limits
75
76
XAPIAN_VALUE_PKGNAME - pkgname
5 by Michael Vogt
README:
77
XAPIAN_VALUE_ICON - icon name
38 by Michael Vogt
README: add information about dbus match limits
78
XAPIAN_VALUE_GETTEXT_DOMAIN - gettext domain
49 by Michael Vogt
make the AppViewFilter more generic and add the archive-section as a value to the xapian database
79
XAPIAN_VALUE_ARCHIVE_SECTION - archive section (main, restricted, universe, multiverse)
59 by Michael Vogt
add popcon to the xapian db and use it in the searches
80
XAPIAN_VALUE_ARCHIVE_ARCH - architectures (seperated with ",", e.g. i386,amd64) - may be empty
100 by Michael Vogt
show the summary in the software list
81
XAPIAN_VALUE_POPCON - popcon data
126 by Michael Vogt
add desktopfile to the xapian db too
82
XAPIAN_VALUE_SUMMARY - summary text
858.2.1 by Michael Vogt
make PYTHONPATH=. python softwarecenter/view/appdetailsview.py work for pay-app example application
83
XAPIAN_VALUE_DESKTOP_FILE - the desktop file that the information comes from
858.2.2 by Michael Vogt
make buy button appear
84
XAPIAN_VALUE_PRICE - the price (if its a for-pay app)
858.2.35 by Michael Vogt
test/test_reinstall_purchased.py: add test code that builds inmemory db of the already purchased items with a special prefix
85
XAPIAN_VALUE_ARCHIVE_CHANNEL - channel (third party)
858.2.21 by Michael Vogt
ported the buy-something to the new AppDetailsViewBase code, the appdetailsview_webkit only for now, _gtk needs to follow
86
XAPIAN_VALUE_ARCHIVE_PPA - the PPA name that the application is in
858.2.35 by Michael Vogt
test/test_reinstall_purchased.py: add test code that builds inmemory db of the already purchased items with a special prefix
87
XAPIAN_VALUE_ARCHIVE_DEBLINE - a deb line for the sources.list to access the given app
88
XAPIAN_VALUE_ARCHIVE_SIGNING_KEYID - signing key id for the repository
858.2.40 by Michael Vogt
support X-AppInstall-Screenshot-Url to make it possible to override default screenshot location
89
XAPIAN_VALUE_PURCHASED_DATE - the data a for-pay app was purchased (only available after the software-center-agent server was queried)
90
XAPIAN_VALUE_SCREENSHOT_URL - a (optional) screenshot url that overrides the default
1046.1.1 by Michael Vogt
start on "where is it" implementation
91
XAPIAN_VALUE_ICON_NEEDS_DOWNLOAD - icon needs to be fetched
92
XAPIAN_VALUE_THUMBNAIL_URL - thumbnail url 
93