X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=version%2FREADME;fp=version%2FREADME;h=b043354606db62ff6849cac40c23144cda456444;hb=2ebe596e3e57e57220afae2b4499aff6348ce3a7;hp=0000000000000000000000000000000000000000;hpb=927617721d01b4a676356787f7792799e3c84223;p=lttng-tools.git

diff --git a/version/README b/version/README
new file mode 100644
index 000000000..b04335460
--- /dev/null
+++ b/version/README
@@ -0,0 +1,16 @@
+On version.i generation, check the content of the following files :
+
+  * "extra_version_name"
+
+    The first line is used to populate the EXTRA_VERSION_NAME pre-processor
+    define statement.
+
+  * "extra_version_description"
+
+    The content is used to populate the EXTRA_VERSION_DESCRIPTION pre-processor
+    define statement.
+
+    It should contain the description of local modifications done to the tree.
+    This can be used by distribution packager to specify what changes were
+    applied locally. Mostly in the form of patch/commit name. All non-alpha
+    numeric characters are converted to "-".