== blender file format ==

- added a readme so that it's easy to understand how to use the py files.
- fixed typos in the usage message.

2 files changed, 31 insertions, 2 deletions

diff --git a/doc/blender_file_format/BlendFileDnaExporter_25.py b/doc/blender_file_format/BlendFileDnaExporter_25.py
index 77656f43ae5..afc58ce6730 100755
--- a/doc/blender_file_format/BlendFileDnaExporter_25.py
+++ b/doc/blender_file_format/BlendFileDnaExporter_25.py
@@ -383,8 +383,8 @@ def usage():
     print("Options:")
     print("\t--dna-keep-blend:      doesn't delete the produced blend file DNA export to html")
     print("\t--dna-debug:           sets the logging level to DEBUG (lots of additional info)")
-    print("\t--dna-versioned'       saves version informations in the html and blend filenames")
-    print("\t--dna-overwrite-css'   overwrite dna.css, useful when modifying css in the script")
+    print("\t--dna-versioned        saves version informations in the html and blend filenames")
+    print("\t--dna-overwrite-css    overwrite dna.css, useful when modifying css in the script")
     print("Examples:")
     print("\tdefault:       % blender2.5 -b -P BlendFileDnaExporter_25.py")
     print("\twith options:  % blender2.5 -b -P BlendFileDnaExporter_25.py -- --dna-keep-blend --dna-debug\n")
diff --git a/doc/blender_file_format/README b/doc/blender_file_format/README
new file mode 100644
index 00000000000..55dc3b83e49
--- /dev/null
+++ b/doc/blender_file_format/README
@@ -0,0 +1,29 @@
+To inspect the blend-file-format used by a certain version of blender 2.5x,
+navigate to this folder and run this command:
+
+blender2.5 -b -P BlendFileDnaExporter_25.py
+
+where "blender2.5" is your blender executable or a symlink to it.
+
+This creates a temporary dna.blend to be inspected and it produces two new files:
+
+* dna.html: the list of all the structures saved in a blend file with the blender2.5
+            executable you have used. If you enable build informations when you build blender,
+            the dna.html file will also show which svn revision the html refers to.
+* dna.css:  the css for the html above
+
+Below you have the help message with a list of options you can use.
+
+
+Usage:
+        blender2.5 -b -P BlendFileDnaExporter_25.py [-- [options]]
+Options:
+        --dna-keep-blend:      doesn't delete the produced blend file DNA export to html
+        --dna-debug:           sets the logging level to DEBUG (lots of additional info)
+        --dna-versioned        saves version informations in the html and blend filenames
+        --dna-overwrite-css    overwrite dna.css, useful when modifying css in the script
+Examples:
+        default:       % blender2.5 -b -P BlendFileDnaExporter_25.py
+        with options:  % blender2.5 -b -P BlendFileDnaExporter_25.py -- --dna-keep-blend --dna-debug
+
+