From 80409cad954dc8c0a65d4e835903503849cdd3ed Mon Sep 17 00:00:00 2001
From: Thomas Hartmann <Thomas.Hartmann@nokia.com>
Date: Mon, 10 Sep 2012 13:08:23 +0200
Subject: [PATCH] QmlJS: Document script to generate parser copy.

Change-Id: Ib35f718fef7a9621247dbc468bcfa4f3ea425c50
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@nokia.com>
---
 src/libs/qmljs/parser/gen-parser.sh | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/libs/qmljs/parser/gen-parser.sh b/src/libs/qmljs/parser/gen-parser.sh
index 1a755052e91..e6fdadf6757 100755
--- a/src/libs/qmljs/parser/gen-parser.sh
+++ b/src/libs/qmljs/parser/gen-parser.sh
@@ -1,5 +1,15 @@
 #!/bin/bash
 
+# This is the script that generates the copy of the QmlJS parser from the sources
+# in the qtdeclarative source tree.
+#
+# It applies a bunch of renames to make the source compatible with the Qt Creator
+# sources as well as rewrites of the licenses.
+#
+# Example:
+# cd src/libs/qmljs/parser
+# QTDIR=~/path/to/qtdeclarative-checkout ./gen-parser.sh
+
 me=$(dirname $0)
 
 for i in $QTDIR/src/qml/qml/parser/*.{g,h,cpp,pri}; do