Skip to content

Commit

Permalink
Create a "Gotchas" page
Browse files Browse the repository at this point in the history
This page will detail situations I've encountered where
Syncrepl just did not work the way I expected.
  • Loading branch information
akkornel committed Dec 7, 2017
1 parent 5204c0a commit 676a2aa
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/gotchas.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
..
Syncrepl Client documentation: Gotchas page
Refer to the AUTHORS file for copyright statements.
This work is licensed under a
Creative Commons Attribution-ShareAlike 4.0 International Public License,
the text of which may be found in the file `LICENSE_others.md` that was
included with this distribution, and also at
https://github.com/akkornel/syncrepl/blob/master/LICENSE_others.md
Code contained in this document is also licensed under the BSD 3-Clause
License, the text of which may be found in the file `LICENSE.md` that was
included with this distribution, and also at
https://github.com/akkornel/syncrepl/blob/master/LICENSE.md
See the LICENSE file for full license texts.
Syncrepl "Gotcha!"s
===================

The Syncrepl protocol is definitely not the simplest thing in the world to deal
with [#f1]_. In my (limited) time dealing with Syncrepl stuff, I have run in
to a number of areas where I get behavior that is not what I expect, even
though Syncrepl is doing exactly what it is supposed to do.

.. [#f1] Source: Me; the LDAP admins of Stanford University IT, including Linda
Laubenheimer and Adam Lewenberg; and others.
In this document, I plan on covering some of the weirdnesses I have discovered
when dealing with Syncrepl.

1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Welcome to Syncrepl Client's documentation!
The Client Class <client>
Callbacks <callbacks>
Exceptions <exceptions>
Gotchas <gotchas>
Index <genindex>

**syncrepl_client** is a Python module that makes LDAP Syncrepl easy to use.
Expand Down

0 comments on commit 676a2aa

Please sign in to comment.