summaryrefslogtreecommitdiff
path: root/src/mongo/util/mongoutils/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/util/mongoutils/README')
-rwxr-xr-xsrc/mongo/util/mongoutils/README15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/mongo/util/mongoutils/README b/src/mongo/util/mongoutils/README
new file mode 100755
index 00000000000..f61277c7409
--- /dev/null
+++ b/src/mongo/util/mongoutils/README
@@ -0,0 +1,15 @@
+ mongoutils namespace requirements:
+
+ (1) code is not database specific, rather, true utilities
+ (2) are cross platform
+ (3) may require boost headers, but not libs
+ (4) are clean and easy to use in any c++ project without pulling in lots of other stuff.
+ specifically, does not use anything in the mongo namespace!
+ (5) apache license
+ (6) must be documented! if you aren't going to bother (but don't do that), stick it in util.
+ (7) ideally header only (in the spirit of #3)
+
+ So basically, easy to use, general purpose stuff, with no arduous dependencies to drop into
+ any new project.
+
+ *** PLACE UNIT TESTS IN mongoutils/test.cpp ***