BIND 10 trac931_2, updated. 5178a891fb3713609ade921d010bed453498f355 [trac931] Comment

[BIND 10 source code commits]

The branch, trac931_2 has been updated
       via  5178a891fb3713609ade921d010bed453498f355 (commit)
      from  e9975a7383a299789fd18b184880a00dfb0e15ed (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 5178a891fb3713609ade921d010bed453498f355
Author: Michal 'vorner' Vaner <michal.vaner at nic.cz>
Date:   Thu May 26 11:16:36 2011 +0200

    [trac931] Comment

-----------------------------------------------------------------------

Summary of changes:
 src/lib/server_common/keyring.h |   16 +++++++++++-----
 1 files changed, 11 insertions(+), 5 deletions(-)

-----------------------------------------------------------------------
diff --git a/src/lib/server_common/keyring.h b/src/lib/server_common/keyring.h
index 8832095..9c067e9 100644
--- a/src/lib/server_common/keyring.h
+++ b/src/lib/server_common/keyring.h
@@ -28,14 +28,20 @@
  * on updates.
  *
  * You simply initialize/load the keyring with isc::server_common::initKeyring
- * and then just use the key ring in in isc::server_common::keyring. It is
- * automatically reloaded, when the configuration updates, so you no longer
+ * and then just use the key ring referred to by isc::server_common::keyring. It
+ * is automatically reloaded, when the configuration updates, so you no longer
  * needs to care about it.
  *
  * If you want to keep a key (or session) for longer time or your application
- * is multithreaded, you might want to have a copy of the shared pointer.
- * Otherwise an update might replace the keyring and delete the keys in the
- * old one.
+ * is multithreaded, you might want to have a copy of the shared pointer to
+ * hold a reference. Otherwise an update might replace the keyring and delete
+ * the keys in the old one.
+ *
+ * Also note that, while the interface doesn't prevent application from
+ * modifying the keyring, it is not a good idea to do so. As mentioned above,
+ * it might get reloaded at any time, which would replace the modified keyring.
+ * The possibility to modify it is side effect of simpler implementation and
+ * shorter code, not a goal.
  */
 
 namespace isc {