summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update spec and prepare 1.2 releasePrashanth Pai2018-09-191-1/+1
| | | | | Change-Id: Iabb38be823cba803a864ca4769e2cac595ebe75c Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Update install guide with RPM namePrashanth Pai2017-04-262-7/+7
| | | | | | | ...and fix some minor doc rendering. Change-Id: Ibec7a39bf2633026b106972d4d476d5734232b5f Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Add install instructions for pipPrashanth Pai2016-08-161-1/+9
| | | | | | | The python bindings is now available for installation using pip. Change-Id: Ifc2def21e3b099b024a670422e444de82ca52cc6 Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Release version 1.1v1.1Prashanth Pai2016-08-161-1/+1
| | | | | Change-Id: Ia134ba44f56fbb94c0b988c2353c59e1a25fbbc7 Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Expose glfs_readdirplus_rPrashanth Pai2016-06-301-0/+5
| | | | | | | | | | | | | | | | This patch does the following: * Implements Volume.listdir_with_stat() API which internally invokes glfs_readdirplus_r to return directory entries along with stat for each entry. * Implements Volume.scandir() which is similar to os.scandir() present in Python 3.5 * Makes Dir class iterable. * Enables Dir class to raise OSError when glfs_readdir* calls fail. Previously, these failures were silently being ignored and treated as a case of EOF. Change-Id: Id918c39a7ef3882553e9bcd3fbf9455ee1c25a83 Signed-off-by: Prashanth Pai <ppai@redhat.com>
* doc: Add troubleshooting sectionPrashanth Pai2016-06-172-30/+52
| | | | | | | | | | * Mention glusterfs versions which requires additional steps to allow non-root users to mount the volume. * Add note on tested platform and python versions. * Remove TODOs and add them as issues on GitHub Change-Id: I36a63ff2b9f98de82c2fd58542584565dab7dda0 Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Document mounting as non-root userPrashanth Pai2016-06-161-1/+31
| | | | | Change-Id: I58baf2b6b24bf07707be133508b5d1213744562e Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Improve sphinx rendering on RTDPrashanth Pai2016-06-105-20/+46
| | | | | Change-Id: I646b5d26bca6d4f0123c1b2140f80f24d268568e Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Fix typo in documentationPrashanth Pai2016-06-091-1/+1
| | | | | Change-Id: Ic6bcde358e718ef6cab3b37f1a318d2cada6e97f Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Revamp and complete API documentationPrashanth Pai2016-06-094-0/+644
| | | | | | | | | Created .rst files that sphinx can use to auto-generate entire API documentation from doc strings present in code. This can be easily rendered and hosted on ReadTheDocs website. Change-Id: If1a569bdeaaba21919ac77ba8bd4967dfec22603 Signed-off-by: Prashanth Pai <ppai@redhat.com>
* Merge "functests: Change default host name to localhost"Humble Devassy Chirammal2016-02-171-1/+1
|\
| * functests: Change default host name to localhostPrashanth Pai2015-09-161-1/+1
| | | | | | | | | | | | | | | | | | Without this change, user (developer) will have to modify test.conf (tracked by git) every time he has to run functional tests or has to edit /etc/hosts and add entry for 'gfshost' Change-Id: I6d41a657b0cae614513e2925e73138da46ddaf04 Signed-off-by: Prashanth Pai <ppai@redhat.com>
* | updated dev guide to tell users to update their test.conf fileZandrr2015-07-201-0/+1
|/ | | | Change-Id: I86176486ad729b2dec16c60cddbd803354cc64bb
* Correcting the project url in READMEHumble Chirammal2015-02-241-2/+2
| | | | | Change-Id: I89224d961cba538bc732682e64f0658e5b5e7d80 Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
* Fix functional testsPrashanth Pai2014-05-191-1/+1
| | | | | | | | | | | | | | * The order of elements in list returned by listdir() can vary and may not be sorted. This caused assertEqual in "test_listdir" to fail. * Also, some systems may have xattrs belonging to selinux. So, a listxattr can list them too. * Allow hostname/ip and volume name to be configured easily by setting it in test.conf. This enables functional tests to use a non-local volume. * Cleanup volume before and after running functional tests. * Added MANIFEST.in and LICENSE file Change-Id: Icfa6eb60e8d8e7ed4d6ab8190a2a2c80688999a3 Signed-off-by: Prashanth Pai <ppai@redhat.com>
* adding information about tox and virtualenvThiago da Silva2014-03-171-4/+6
| | | | | | | | | | There's currently an issue with the latest version of tox and this is keeping people from running the tests. Installing the previous version is a workaround until the problem with tox is solved Change-Id: I3d8a842038f6265daf42c5624ef209bf248570a6 Signed-off-by: Thiago da Silva <thiago@redhat.com>
* Add Gerrit documentationLuis Pabon2014-02-131-23/+169
| | | | | Change-Id: I48df12b8627ef2b0c4dfedadcb90864e4a537019 Signed-off-by: Luis Pabon <lpabon@redhat.com>
* first libgfapi-python functional testsThiago da Silva2014-01-221-0/+130
adding a few functional tests and removing old tests from source code Change-Id: Iefcb091d614f2825592943cfb42847b5865322c6 Signed-off-by: Thiago da Silva <thiago@redhat.com>