X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;ds=sidebyside;f=src%2Fpython-systemd%2Fdocs%2Fjournal.rst;h=9dc495ffdb685ff5b331f822598b82e2a6183366;hb=f2e82cd5add31d704b39a91d570ab6649653fa49;hp=38ab57e45b806fb7db3350ceb568293b99a4cc78;hpb=86e3d32a1d52cd2ccba184e8375da8828914d3ff;p=elogind.git

diff --git a/src/python-systemd/docs/journal.rst b/src/python-systemd/docs/journal.rst
index 38ab57e45..9dc495ffd 100644
--- a/src/python-systemd/docs/journal.rst
+++ b/src/python-systemd/docs/journal.rst
@@ -13,11 +13,11 @@
 Accessing the Journal
 ---------------------
 
-.. autoclass:: _Journal
+.. autoclass:: _Reader
    :undoc-members:
    :inherited-members:
 
-.. autoclass:: Journal
+.. autoclass:: Reader
    :undoc-members:
    :inherited-members:
 
@@ -27,12 +27,23 @@ Accessing the Journal
 
 .. autoattribute:: systemd.journal.DEFAULT_CONVERTERS
 
-Whence constants
-~~~~~~~~~~~~~~~~
+Example: polling for journal events
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This example shows that journal events can be waited for (using
+e.g. `poll`). This makes it easy to integrate Reader in an external
+event loop:
+
+  >>> import select
+  >>> from systemd import journal
+  >>> j = journal.Reader()
+  >>> j.seek_tail()
+  >>> p = select.poll()
+  >>> p.register(j, select.POLLIN)
+  >>> p.poll()
+  [(3, 1)]
+  >>> j.get_next()
 
-.. autoattribute:: systemd.journal.SEEK_SET
-.. autoattribute:: systemd.journal.SEEK_CUR
-.. autoattribute:: systemd.journal.SEEK_END
 
 Journal access types
 ~~~~~~~~~~~~~~~~~~~~