add documentation

git-svn-id: http://luarocks.org/svn/luarocks/trunk@120 9ca3f7c1-7366-0410-b1a3-b5c78f85698c

1 files changed, 6 insertions, 0 deletions

diff --git a/src/luarocks/cfg.lua b/src/luarocks/cfg.lua
index 710ca8f4..0cf58ba3 100644
--- a/src/luarocks/cfg.lua
+++ b/src/luarocks/cfg.lua
@@ -7,6 +7,12 @@ local rawset, next, table, pairs, print, require, io, os, setmetatable, pcall, i
 -- defines defaults for unset values. See the
 -- <a href="http://luarocks.org/en/Config_file_format">config
 -- file format documentation</a> for details.
+--
+-- End-users shouldn't edit this file. They can override any defaults
+-- set in this file using their system-wide $LUAROCKS_SYSCONFIG file
+-- (see luarocks.config) or their user-specific configuration file
+-- (~/.luarocks/config.lua on Unix or %APPDATA%/luarocks/config.lua on
+-- Windows).
 module("luarocks.cfg")
 
 -- Load site-local global configurations