added some doc

joelmarty · Sep 16, 2013 · 2afc8a4 · 2afc8a4
1 parent 8da3419
commit 2afc8a4
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/svn_markup.rb b/svn_markup.rb
@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 # coding: utf-8
+#
+# This script adds SVN keyword tags Revision and Date to XML/HTML files, just below the XML header or the DOCTYPE declaration.
+# doctype because that's how our "embedded" html pages need to be.
+# if one of both headers is not detected, it will assume it's XML and add it.
 
 XML_MARKUP = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"
 SVN_MARKUP = "<!--\n$Revision$\n$Date$\n-->"