doc: tag files containing internal implementation details

We don't want our users to rely on them

7 files changed, 10 insertions, 0 deletions

diff --git a/lib/mogilefs/httpfile.rb b/lib/mogilefs/httpfile.rb
index 560dc23..f415bba 100644
--- a/lib/mogilefs/httpfile.rb
+++ b/lib/mogilefs/httpfile.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# here are internal implementation details, do not use them in your code
 require 'stringio'
 require 'uri'
 require 'mogilefs/backend'
diff --git a/lib/mogilefs/network.rb b/lib/mogilefs/network.rb
index 95647d2..52dc257 100644
--- a/lib/mogilefs/network.rb
+++ b/lib/mogilefs/network.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# here are internal implementation details, do not use them in your code
 require 'mogilefs'
 require 'socket'
 require 'mogilefs/util'
diff --git a/lib/mogilefs/socket.rb b/lib/mogilefs/socket.rb
index b35baa9..b52ba53 100644
--- a/lib/mogilefs/socket.rb
+++ b/lib/mogilefs/socket.rb
@@ -1,3 +1,5 @@
+# -*- encoding: binary -*-
+# internal implementation details here, do not rely on this in your code
 require "mogilefs/socket_common"
 begin
   raise LoadError, "testing pure Ruby version" if ENV["MOGILEFS_CLIENT_PURE"]
diff --git a/lib/mogilefs/socket/kgio.rb b/lib/mogilefs/socket/kgio.rb
index 91f6392..292ea7e 100644
--- a/lib/mogilefs/socket/kgio.rb
+++ b/lib/mogilefs/socket/kgio.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# internal implementation details here, do not rely on them in your code
 require "kgio"
 
 class MogileFS::Socket < Kgio::Socket
diff --git a/lib/mogilefs/socket/pure_ruby.rb b/lib/mogilefs/socket/pure_ruby.rb
index b81442f..6b9efc0 100644
--- a/lib/mogilefs/socket/pure_ruby.rb
+++ b/lib/mogilefs/socket/pure_ruby.rb
@@ -1,3 +1,5 @@
+# -*- encoding: binary -*-
+# internal implementation details here, do not rely on them in your code
 require "socket"
 require "io/wait"
 require "timeout"
diff --git a/lib/mogilefs/socket_common.rb b/lib/mogilefs/socket_common.rb
index e724e8f..f6d0f2a 100644
--- a/lib/mogilefs/socket_common.rb
+++ b/lib/mogilefs/socket_common.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# internal implementation details here, do not rely on this in your code
 require "socket"
 
 module MogileFS::SocketCommon
diff --git a/lib/mogilefs/util.rb b/lib/mogilefs/util.rb
index 24bba2d..6b46c97 100644
--- a/lib/mogilefs/util.rb
+++ b/lib/mogilefs/util.rb
@@ -3,6 +3,8 @@ require 'mogilefs'
 require 'socket'
 
 module MogileFS::Util
+
+  # here are internal implementation details, do not use them in your code
   # TODO: cleanup
   if IO.respond_to?(:copy_stream)
     def copy_stream(src, dst)