Browse Source

[2899] added a README file explaining the intent of the interproc stuff

JINMEI Tatuya 12 years ago
parent
commit
6ed2d962ac
2 changed files with 15 additions and 0 deletions
  1. 2 0
      src/lib/log/interprocess/Makefile.am
  2. 13 0
      src/lib/log/interprocess/README

+ 2 - 0
src/lib/log/interprocess/Makefile.am

@@ -17,3 +17,5 @@ libb10_log_interprocess_la_SOURCES += interprocess_sync_null.h
 libb10_log_interprocess_la_SOURCES += interprocess_sync_null.cc
 libb10_log_interprocess_la_SOURCES += interprocess_sync_null.cc
 
 
 libb10_log_interprocess_la_LIBADD  = $(top_builddir)/src/lib/util/threads/libb10-threads.la
 libb10_log_interprocess_la_LIBADD  = $(top_builddir)/src/lib/util/threads/libb10-threads.la
+
+EXTRA_DIST  = README

+ 13 - 0
src/lib/log/interprocess/README

@@ -0,0 +1,13 @@
+The files in this directory implement a helper sub-library of the
+inter process locking for the log library.  We use our own locks
+because such locks are only available in relatively recent versions of
+log4cplus.  Also (against our usual practice) we somehow re-invented
+an in-house version of such a general purose library rather than
+existing proven tools such as boost::interprocess.  While we decided
+to go with the in-house version for the log library at least until we
+completely swith to log4cplus's native lock support, no other BIND 10
+module should use this; they should use existing external
+tools/libraries.
+
+This sub-library is therefore "hidden" here.  As such, none of these
+files should be installed.