# HG changeset patch # User Marcin Kasperski # Date 2015-10-20 05:54:52 # Node ID 08bc236c2844e8ae2e5fb9babc9ee757bc3b34ac # Parent 7104de734e11a7951b2ca78d01f2f83820c2ee64 Docs with respect to meu diff --git a/README.txt b/README.txt --- a/README.txt +++ b/README.txt @@ -1,4 +1,4 @@ -.. -*- mode: rst -*- +.. -*- mode: rst; compile-command: "rst2html README.txt README.html" -*- ================= mercurial_keyring @@ -18,12 +18,13 @@ How does it work The extension prompts for the password on the first pull/push (in case of HTTP) or first email (in case of SMTP), just like it is done by -default, but saves the password. On successive runs it checks for the -username in ``.hg/hgrc``, then for suitable password in the password -database, and uses those credentials (if found). +default, but saves the password in password database. On successive +runs, whenever the password is needed, it checks for the username in +``.hg/hgrc``, then for suitable password in the password database, and +uses those credentials (if found). In case password turns out to be incorrect (either because it was -invalid, or because it was changed on the server) or missing it just +invalid, or because it was changed on the server) or missing, it just prompts the user again. Passwords are identified by the combination of username and remote @@ -36,48 +37,60 @@ Installation Prerequisites ------------- -Install the keyring_ library: +This extension requires keyring_ and `mercurial_extension_utils`_ to +work. In many cases both will be installed automatically while you +install `mercurial_keyring`_, but you may need to control the process. + +The keyring_ library can usually be installed by:: -:: + pip install --user keyring - easy_install keyring +(or ``easy_install keyring``), but on some systems it is preferable to +use official distribution archive. For example, on Debian and Ubuntu, +you may install ``python-keyring`` and either ``python-keyring-gnome`` +or ``python-keyring-kwallet`` packages:: -(or ``pip keyring``). On Debian "Sid" the library can be also -installed from the official archive (packages ``python-keyring`` -and either ``python-keyring-gnome`` or ``python-keyring-kwallet``). + sudo apt-get install python-keyring python-keyring-gnome + +(this will save you the need to provide working compiler and various +development libraries). -Note: keyring >= 0.3 is strongly recommended, especially in case text -backend is to be used. +The `mercurial_extension_utils`_ module is tiny Python-only module, +which can be installed by:: -.. _this keyring fork: https://bitbucket.org/sborho/python-keyring-lib + pip install --user mercurial_extension_utils + +but in some cases (Windows…) require more care. See `mercurial_extension_utils`_ documentation. + Extension installation ---------------------- There are two possible ways of installing the extension: using PyPi package, -or using individual file. +or using source clone. -To install as a package use ``easy_install``: - -:: +To install as a package:: - easy_install mercurial_keyring + pip install --user mercurial_keyring -and then enable it in ``~/.hgrc`` (or ``/etc/mercurial/hgrc``) using: - -:: +(or ``sudo pip install mercurial_keyring`` for system-wide +installation) and then enable it in ``~/.hgrc`` (or +``/etc/mercurial/hgrc`` or ``Mercurial.ini``) using:: [extensions] mercurial_keyring = -To install using individual file, download the -`mercurial_keyring.py`_ file, save it anywhere you like, and -put the following in ``~/.hgrc`` (or ``/etc/mercurial/hgrc``): +To install as source clone, install keyring_ according to instructions above, then +clone:: + + hg clone https://bitbucket.org/Mekk/mercurial_keyring/ + hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/ -:: +and configure Mercurial by telling it full path to the extension +(in ):: [extensions] - hgext.mercurial_keyring = /path/to/mercurial_keyring.py + mercurial_keyring = /path/to/mercurial_keyring/mercurial_keyring.py .. _the code: .. _mercurial_keyring.py: http://bitbucket.org/Mekk/mercurial_keyring/src/tip/mercurial_keyring.py @@ -204,3 +217,6 @@ Information about this extension is also on Mercurial Wiki: http://mercurial.selenic.com/wiki/KeyringExtension .. _HISTORY.txt: http://bitbucket.org/Mekk/mercurial_keyring/src/tip/HISTORY.txt +.. _TortoiseHg: http://tortoisehg.bitbucket.org/ +.. _Mercurial: http://mercurial.selenic.com +.. _mercurial_extension_utils: https://bitbucket.org/Mekk/mercurial-extension_utils/ diff --git a/setup.py b/setup.py --- a/setup.py +++ b/setup.py @@ -36,7 +36,7 @@ setup( ], install_requires=[ 'keyring>=0.3', - 'mercurial_extension_utils>=0.9.0', + 'mercurial_extension_utils>=0.10.0', ], zip_safe=True, )