summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* patchwork: Explicitly load states fixturesJeremy Kerr2015-06-051-3/+3
| | | | | | | | | | | Apps with migrations will no longer load the initial_data fixtures by default. In order to prepare to add migrations to patchwork, rename the initial_data fixture to default_states (to match the default_tags fixture), and explicitly load them in tests that require them. Also, include this step in the INSTALL document. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* cron: Move patchwork-cron script to a management commandJeremy Kerr2015-05-282-3/+8
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* doc: Add NEWS file for recent updatesJeremy Kerr2015-05-281-0/+60
| | | | | | ... containing a guide to migrating to the recent changes. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Add patch tag infrastructureJeremy Kerr2015-05-281-1/+6
| | | | | | | | | | | | | | | | | | | | | This change add patch 'tags', eg 'Acked-by' / 'Reviewed-by', etc., to patchwork. Tag parsing is implemented in the patch parser's extract_tags function, which returns a Counter object of the tags in a comment. These are stored in the PatchTag (keyed to Tag) objects associated with each patch. We need to ensure that the main patch lists do not cause per-patch queries on the Patch.tags ManyToManyField (this would result in ~500 queries per page), so we introduce a new QuerySet (and Manager) for Patch, adding a with_tag_counts() method to populate the tag counts in a single query. As users may be migrating from previous patchwork versions (ie, with no tag counts in the database), we add a 'retag' management command. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Add collectstatic step to installation instructionsJeremy Kerr2015-05-281-1/+5
| | | | | | | Because we're now using the staticfiles app, we need to run collectstatic on init. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Update documentation and default settings to suit patchwork deployment modelJeremy Kerr2015-05-281-4/+10
| | | | | | | | | | | | We've always allowed configuration without altering any of the version-controlled files. With the recent settings changes, we have an extra level of indirection with the dev/prod settings modules. Since we have to edit a config file anyway, this change moves the prod.py settings file to a template, which is then used directly by mange.py (and the wsgi application). Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Fix documentation for new settings infrastructureJeremy Kerr2015-05-271-1/+2
| | | | | | | A few tweaks for the INSTALL doc to update to the settings changes from c641660e. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Move to a more recent django project structureJeremy Kerr2015-05-272-9/+8
| | | | | | | | | | This change updates patchwor to the newer project struture: we've moved the actual application out of the apps/ directory, and the patchwork-specific templates to under the patchwork application. This gives us the manage.py script in the top-level now. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Use 'prod' and 'dev' requirements filesStephen Finucane2015-05-036-9/+5
| | | | | | | | | | | | | | | | Django 1.5 and 1.6 are no longer supported. https://docs.djangoproject.com/en/dev/internals/release-process/ As a result, one should not encourage people to develop and/or deploy against these versions - the latest version of Django supported by patchwork (currently 1.7) should be used for both. In addition, rather than duplicating shared requirements for 'dev' and 'prod' environments, move all shared requirements to a "base" file. Signed-off-by: Stephen Finucane <stephenfinucane@hotmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* INSTALL: Fix indentation (whitespace only change) to 4 spacesBryce Harrington2015-03-221-46/+57
| | | | | | | Also, 2 newlines after each section. Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* INSTALL: Fix some minor typosBryce Harrington2015-03-221-4/+4
| | | | | Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* INSTALL: fix mysql syntaxBrian Norris2015-03-221-1/+1
| | | | | | | You shouldn't quote ('') the database name. MySQL complains if you do. Signed-off-by: Brian Norris <computersforpeace@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* TODO: remove completed itemsBrian Norris2015-03-221-4/+0
| | | | | | | | | IIUC, these items have all been completed. (The 'bundle' part of --signoff is not completed, but that is represented in the previous bullet.) Signed-off-by: Brian Norris <computersforpeace@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Add a note about how to run testsDamien Lespiau2014-11-101-0/+16
| | | | | | | | Given that hacking on patchwork is spaced in time, I always forget how to do this. So write down a note. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Add the Debian package name for virtualenv/mysqlDamien Lespiau2014-11-101-1/+2
| | | | | Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Add requirements.txt for django 1.7/MySQLDamien Lespiau2014-09-071-0/+3
| | | | | | | | Note: a lot of tests fail due to the removal of the long deprecated AUTH_PROFILE_MODULE. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Add requirements.txt for django 1.6/MySQLDamien Lespiau2014-09-071-0/+3
| | | | | Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Add requirements.txt for django 1.5/MySQLDamien Lespiau2014-09-071-0/+3
| | | | | Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* HACKING: Add some documentation about using virtualenv with patchworkDamien Lespiau2014-09-071-0/+52
| | | | | | | | | virtualenv is super nice to isolate devevelopment from the python packages installed in the sytem. It also allows to have parallel configurations to run tests againsts. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* INSTALL: Sprinkle a few UTF-8 in the mysql documentationDamien Lespiau2014-09-071-1/+6
| | | | | | | | | | | | | | | | | When not specifying the charset/collation, I managed to create a latin1 database where all strings were encoded in latin1. That's really not ideal. Adding 'CHARACTER SET utf8' when creating the DB fixes it. Then: $ ./manage.py syncdb will correctly create tables with UTF-8 encoded rows. However, for some reason, when django creates the test tables, that default, DB wide, encoding is not respected and one needs to provide an additional TEST_CHARSET entry in the config dictionary. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* INSTALL: Update the database configuration instructionsDamien Lespiau2014-09-071-12/+20
| | | | | | | | | That's the "new" (django 1.5+) way of defining databases, strictly following the instructions wasn't working. This should save the next user a bit of time. Signed-off-by: Damien Lespiau <damien.lespiau@intel.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* settings.py: use python to find ROOT_DIRAndreas Bießmann2014-07-241-7/+0
| | | | | Signed-off-by: Andreas Bießmann <andreas@biessmann.de> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* INSTALL: adopt PYTHONPATHAndreas Bießmann2014-07-241-1/+1
| | | | | Signed-off-by: Andreas Bießmann <andreas@biessmann.de> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs/INSTALL: Add setup details for patchwork cron scriptJeremy Kerr2014-04-241-1/+17
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Add a pointer to the git post-receive hookCarl Worth2014-01-291-0/+17
| | | | | | | | | | I had to stumble upon this feature before I realized it was here inside the tools directory all along. This documentation should make it easier for the next person coming along looking for a patchwork git hook. Signed-off-by: Carl Worth <cworth@cworth.org> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: We're targetting django 1.5 nowJeremy Kerr2013-10-131-3/+3
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: also mention that ROOT_DIR needs to be updatedFlorian Fainelli2013-10-041-0/+1
| | | | | | | | | When the patchwork installation resides in the non-default location (/srv/patchwork) make sure that local_settings.py also gets updated with a proper ROOT_DIR value otherwise various problems will happen. Signed-off-by: Florian Fainelli <f.fainelli@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: fix INSTALL instructions regarding DjangoFlorian Fainelli2013-10-041-2/+2
| | | | | | | | | | Django is no longer accessible using the old Subversion URL, update that to the Github repository. Besides, the command-line used to perform the "syncdb" operation does not work because we are off by one directory in the filesystem, fix that. Signed-off-by: Florian Fainelli <f.fainelli@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: update MySQL documentation bitsFlorian Fainelli2013-10-041-1/+13
| | | | | | | | | | | | The MySQL documentation bits where missing a few important details for installation setup to succeed like: - having proper python-mysqldb support - overriding the DATABASE_ENGINE to "mysql" for django to succeed in the "syncdb" operation Signed-off-by: Florian Fainelli <f.fainelli@gmail.com> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* js: Add jquery and jquery tablednd pluginsJeremy Kerr2013-06-161-12/+0
| | | | | | | | | | | | Based on a change from Andreas Bießmann <andreas@biessmann.de>. Rather than requiring a download of the jquery library + tablednd plugin, commit these to the repository. In doing so, we upgrade to version 1.10.1 of jqeury, and the current stable tablednd. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Merge branch 'notifications'Jeremy Kerr2011-09-191-11/+2
|\
| * notifications: Add NOTIFICATION_FROM_EMAIL settingJeremy Kerr2011-04-141-0/+2
| | | | | | | | | | | | Allow a separate From: address for notificaton emails. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
| * registration: use EmailConfimation rather than separate registration appJeremy Kerr2011-04-141-11/+0
| | | | | | | | | | | | | | | | | | | | Since we have infrastructure for email confirmations, we no longer need the separate registration app. Requires a migration script, which will delete all inactive users, including those newly added and pending confirmation. Use carefully. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* | Patchwork now requires Django 1.2, so state that in docs/INSTALLGuilherme Salgado2011-04-191-3/+3
|/ | | | | Signed-off-by: Guilherme Salgado <guilherme.salgado@linaro.org> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Fix link creation exampleDirk Wallenstein2011-02-111-1/+1
| | | | | Signed-off-by: Dirk Wallenstein <halsmit@t-online.de> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: fix apache2 referencesJeremy Kerr2010-08-101-3/+3
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* lib/apache2: Add WSGI HandlerMartin Krafft2010-08-101-2/+14
| | | | | | | | | | | | | | | | | | | Patchwork/Django can be run directly with WSGI, which is bound to be faster and less complex than FastCGI. This patch provides the necessary Apache configuration and the WSGI handler, as well as an update to the docs. Since python-flup is deprecated and WSGI supersedes FastCGI, it should be(come) the preferred method. Hence I documented it first. For the xmlrpc interface to work with WSGI, the HTTP authorization information needs to be passed to the WSGI handler. This is done by setting WSGIPassAuthorization On in the apache2 config file snippet. Ref: http://www.arnebrodowski.de/blog/508-Django,-mod_wsgi-and-HTTP-Authentication.html Signed-off-by: martin f. krafft <madduck@madduck.net> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Document password-based pgsql loginMartin Krafft2010-08-101-3/+24
| | | | | | | | | As an alternative to ident-based authentication for PostgreSQL, one can use password-based authentication. This patch adds the alternative to the docs. Signed-off-by: martin f. krafft <madduck@madduck.net> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: reformat INSTALLJeremy Kerr2010-08-101-55/+55
| | | | | | Fix up some tabs. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: elaborate on lib/ dirs in INSTALLJeremy Kerr2010-08-101-0/+3
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: update INSTALL for commonly-available packagesJeremy Kerr2010-08-101-6/+8
| | | | | | | We probably don't need to download django or django-registration anymore. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Registration framework maintained on bitbucketMartin Krafft2010-08-101-5/+3
| | | | | | | | The django-registration framework is now maintained on bitbucket, which requires some changes to the in-tree symlink and the documentation. Signed-off-by: martin f. krafft <madduck@madduck.net> Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Add TODO item: changing primary email addressesJeremy Kerr2010-04-271-0/+1
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: Fix typo in INSTALLJeremy Kerr2009-10-231-1/+1
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Add pwclient items to TODOJeremy Kerr2009-09-181-0/+2
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: add note about -pass-header Authorization' to INSTALLJeremy Kerr2009-07-111-0/+8
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: remove completed todo itemsJeremy Kerr2009-02-271-2/+0
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* docs: add items to todoJeremy Kerr2009-02-271-0/+7
| | | | | | Additions to pwclient. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* [docs] Remove done things from TODOJeremy Kerr2009-02-121-2/+0
| | | | Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* Bundle reordering supportJeremy Kerr2009-02-081-0/+12
| | | | | | | | Bundles can now be reordered and saved. Add dependency on jquery in INSTALL. Signed-off-by: Jeremy Kerr <jk@ozlabs.org>