diff --git a/.mailmap b/.mailmap index 8e9a482e09..651622fa95 100644 --- a/.mailmap +++ b/.mailmap @@ -35,3 +35,4 @@ Doug Weimer Li Riqiang lrqrun Cory Wright Julien Danjou +David Hadas diff --git a/doc/source/development_guidelines.rst b/doc/source/development_guidelines.rst index 5682233bfc..369b819eb5 100644 --- a/doc/source/development_guidelines.rst +++ b/doc/source/development_guidelines.rst @@ -30,10 +30,21 @@ To execute the unit tests: - `pip install tox` +* If you do not have python 2.6 installed (as in 12.04): + + - Add `export TOXENV=py27,pep8` to your `~/.bashrc` + + - `. ~/.bashrc` + * Run Tox from the root of the swift repo: - `tox` + Remarks: + if you installed using: `cd ~/swift; sudo python setup.py develop`, + you may need to do: `cd ~/swift; sudo chown -R swift:swift swift.egg-info` + prior to running tox + * Optionally, run only specific tox builds: - `tox -e pep8,py26` @@ -57,6 +68,11 @@ More specifically: the sphinx specific markup can be found here: http://sphinx.pocoo.org/markup/index.html +Installing Sphinx: + #. Install sphinx (On Ubuntu: `sudo apt-get install python-sphinx`) + #. `python setup.py build_sphinx` + + --------------------- License and Copyright --------------------- diff --git a/doc/source/development_saio.rst b/doc/source/development_saio.rst index 3b5c692ad6..e76e7a08b8 100755 --- a/doc/source/development_saio.rst +++ b/doc/source/development_saio.rst @@ -9,11 +9,7 @@ Instructions for setting up a development VM This section documents setting up a virtual machine for doing Swift development. The virtual machine will emulate running a four node Swift cluster. -* Get the *Ubuntu 10.04 LTS (Lucid Lynx)* server image: - - - Ubuntu Server ISO: http://releases.ubuntu.com/lucid/ubuntu-10.04.4-server-amd64.iso (717 MB) - - Ubuntu Live/Install: http://cdimage.ubuntu.com/releases/lucid/release/ubuntu-10.04.4-dvd-amd64.iso (4.2 GB) - - Ubuntu Mirrors: https://launchpad.net/ubuntu/+cdmirrors +* Get either Ubuntu 12.04 LTS (Precise Pangolin) or Ubuntu 10.04 LTS (Lucid Lynx) server image. * Create guest virtual machine from the Ubuntu image. @@ -320,9 +316,7 @@ Sample configuration files are provided with all defaults in line-by-line commen [filter:proxy-logging] use = egg:swift#proxy_logging - #. Create `/etc/swift/swift.conf`: - - .. code-block:: none + #. Create `/etc/swift/swift.conf`:: [swift-hash] # random unique string that can never change (DO NOT LOSE) @@ -739,32 +733,17 @@ Setting up scripts for running Swift #. `chmod +x ~/bin/*` #. `remakerings` + #. `cp ~/swift/test/sample.conf /etc/swift/test.conf` #. `cd ~/swift; ./.unittests` #. `startmain` (The ``Unable to increase file descriptor limit. Running as non-root?`` warnings are expected and ok.) #. Get an `X-Storage-Url` and `X-Auth-Token`: ``curl -v -H 'X-Storage-User: test:tester' -H 'X-Storage-Pass: testing' http://127.0.0.1:8080/auth/v1.0`` #. Check that you can GET account: ``curl -v -H 'X-Auth-Token: ' `` #. Check that `swift` works: `swift -A http://127.0.0.1:8080/auth/v1.0 -U test:tester -K testing stat` - #. `cp ~/swift/test/sample.conf /etc/swift/test.conf` #. `cd ~/swift; ./.functests` (Note: functional tests will first delete everything in the configured accounts.) #. `cd ~/swift; ./.probetests` (Note: probe tests will reset your environment as they call `resetswift` for each test.) -If you plan to work on documentation (and who doesn't?!) you must -install Sphinx and then you can build the documentation: - -On Ubuntu: - #. `sudo apt-get install python-sphinx` - #. `python setup.py build_sphinx` - -On MacOS: - #. `sudo easy_install -U sphinx` - #. `python setup.py build_sphinx` - -Install tox so you find Py26 and PEP8 problems before Jenkins does: - #. `sudo apt-get install python2.6-dev python-pip` - #. `sudo pip install tox` - ---------------- Debugging Issues ----------------