From 20af4921f8983b8df197af7c2ff978cd34328bba Mon Sep 17 00:00:00 2001
From: Pierre Goiffon <pierre.goiffon@combodo.com>
Date: Wed, 24 Mar 2021 16:45:02 +0100
Subject: [PATCH] :bulb: :memo: updateLicenses.php : more documentation

---
 .make/license/updateLicenses.php | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/.make/license/updateLicenses.php b/.make/license/updateLicenses.php
index 778b9cfe7..ff412a391 100644
--- a/.make/license/updateLicenses.php
+++ b/.make/license/updateLicenses.php
@@ -1,11 +1,18 @@
 <?php
 /**
- * script used to sort license file (usefull for autogeneration)
+ * script used to sort license file (useful for autogeneration)
+ * Update license file in `$xmlFilePath`
  *
  * Requirements :
  *  * bash (on Windows, use Git Bash)
+ *  * composer (if you use the phar version, mind to create a `Composer` alias !)
  *  * JQ command //FIXME : how to get it on Windows ?
  *
+ * Licenses sources :
+ *  * `composer licenses --format json` (see https://getcomposer.org/doc/03-cli.md#licenses)
+ *  * keep every existing nodes with `/licenses/license[11]/product/@scope` not in ['lib', 'datamodels']
+ *    ⚠ If licenses were added manually, they might be removed by this tool ! Be very careful to check for the result before pushing !
+ *
  * To launch, simply do `php updateLicenses.php`
  */