[elbe-devel] [PATCH 3/8] docs elbe-genlicence: document ElbeProject changes and also add --xml
Torben Hohn
torben.hohn at linutronix.de
Mon Oct 14 16:57:29 CEST 2019
after switching to ElbeProject, the parameters and argument semantic
changes.
Document that, and also document the --xml option.
Signed-off-by: Torben Hohn <torben.hohn at linutronix.de>
---
docs/elbe-genlicence.txt | 20 +++++++++++++++-----
1 file changed, 15 insertions(+), 5 deletions(-)
diff --git a/docs/elbe-genlicence.txt b/docs/elbe-genlicence.txt
index 48e2caa23..349923f98 100644
--- a/docs/elbe-genlicence.txt
+++ b/docs/elbe-genlicence.txt
@@ -10,8 +10,9 @@ SYNOPSIS
--------
[verse]
'elbe genlicence' \
- [ --output <filename> \
- <builddir>
+ [ --output <filename> ] \
+ [ --xml <xmlfilename> ] \
+ <project-dir>
DESCRIPTION
@@ -28,17 +29,26 @@ OPTIONS
--output <filename>::
Write the result to <filename> instead of 'licence.txt'.
-<builddir>::
+--xml <xmlfilename>::
+ Write an xml file with all the licenses to <xmlfilename>.
+
+--buildtype <buildtype>::
+ Override the buildtype.
+
+--skip-validation::
+ Skip xml schema validation.
+
+<project>::
The build directory of the project to process.
EXAMPLES
--------
-* Generate a licence file for the project in 'myproject' and name the result
+* Generate a licence file for the project in '/var/cache/elbe/<uuid>' and name the result
'myproject-licences.txt'.
+
---------
-# elbe genlicence --output myproject-licences.txt myproject
+# elbe genlicence --output myproject-licences.txt /var/cache/elbe/<uuid>
---------
--
2.20.1
More information about the elbe-devel
mailing list