Merge pull request #287 from getsentry/source-code-docs

Add information around source code configuration and compilation

Author: mitchellhenke

lib/sentry/sources.ex

@@ -47,6 +47,18 @@ defmodule Sentry.Sources do
         [sentry_recompile: ["deps.compile sentry --force", "compile"]]
       end
 
+  This is an important to note especially when building for production. If your
+  build or deployment system caches prior builds, it may not recompile Sentry
+  and could cause issues with reported source code being out of date.
+
+  Due to Sentry reading the file system and defaulting to a recursive search
+  of directories, it is important to check your configuration and compilation
+  environment to avoid a folder recursion issue. Problems may be seen when
+  deploying to the root folder, so it is best to follow the practice of
+  compiling your application in its own folder. Modifying the
+  `source_code_path_pattern` configuration option from its default is also
+  an avenue to avoid compile problems.
+
   """
   @type file_map :: %{pos_integer() => String.t()}
   @type source_map :: %{String.t() => file_map}