summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGiampaolo Rodola <g.rodola@gmail.com>2021-06-06 14:57:31 +0200
committerGiampaolo Rodola <g.rodola@gmail.com>2021-06-06 14:57:31 +0200
commitb6113b0e13353b2ebb6ba191dabc8a1eed2bb9ee (patch)
tree58b700f8d85bc8a4c4b4681ba23b6b09eaeb1312
parent720ae93009d1b33b13df60d4d58fd5cbfe26bfe1 (diff)
downloadpysendfile-b6113b0e13353b2ebb6ba191dabc8a1eed2bb9ee.tar.gz
update README
Signed-off-by: Giampaolo Rodola <g.rodola@gmail.com>
-rw-r--r--README.rst32
1 files changed, 7 insertions, 25 deletions
diff --git a/README.rst b/README.rst
index 2d0e999..060ba2f 100644
--- a/README.rst
+++ b/README.rst
@@ -18,19 +18,17 @@
:target: https://pypi.python.org/pypi/pysendfile/
:alt: License
-===========
-Quick links
-===========
-
-- `Home page <https://github.com/giampaolo/pysendfile>`_
-- `Mailing list <http://groups.google.com/group/py-sendfile>`_
-- `Blog <http://grodola.blogspot.com/search/label/pysendfile>`_
-- `What's new <https://github.com/giampaolo/pysendfile/blob/master/HISTORY.rst>`_
-
=====
About
=====
+A backport of `os.sendfile() <https://docs.python.org/3/library/os.html#os.sendfile>`__
+for Python 2.6 and 2.7 (see `BPO-10882 <https://bugs.python.org/issue10882>`__).
+
+===========
+Explanation
+===========
+
`sendfile(2) <http://linux.die.net/man/2/sendfile>`__ is a system call which
provides a "zero-copy" way of copying data from one file descriptor to another
(a socket). The phrase "zero-copy" refers to the fact that all of the copying
@@ -205,22 +203,6 @@ The supported platforms are:
- **AIX** (not properly tested)
=======
-Support
-=======
-
-Feel free to mail me at *g.rodola [AT] gmail [DOT] com* or post on the the
-mailing list: http://groups.google.com/group/py-sendfile.
-
-======
-Status
-======
-
-As of now the code includes a solid `test suite <https://github.com/giampaolo/pysendfile/blob/master/test/test_sendfile.py>`__ and its ready for production use.
-It's included in `pyftpdlib <http://code.google.com/p/pyftpdlib/>`__
-project and used in production environments for years without any problem being
-reported so far.
-
-=======
Authors
=======