Browse Source

[docs] describe the usage of the static.build.* scripts

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 3 years ago
parent
commit
5a979ff987
1 changed files with 22 additions and 1 deletions
  1. 22 1
      docs/dev/quickstart.rst

+ 22 - 1
docs/dev/quickstart.rst

@@ -29,7 +29,7 @@ If you implement themes, you will need to compile styles and JavaScript before
 
 
 .. code:: sh
 .. code:: sh
 
 
-   make themes
+   make themes.all
 
 
 Don't forget to install npm_ first.
 Don't forget to install npm_ first.
 
 
@@ -53,3 +53,24 @@ Don't forget to install npm_ first.
 
 
 	 sudo -H dnf install npm
 	 sudo -H dnf install npm
 
 
+If you finished your *tests* you can start to commit your changes.  To separate
+the changed code from the build products first run:
+
+.. code:: sh
+
+   make static.build.restore
+
+This will restore the old build products and only your changes of the code
+remain in the working tree which can now be added & commited.  When all sources
+are commited, you can commit the build products simply by:
+
+.. code:: sh
+
+   make static.build.commit
+
+Commiting the build products should be the last step, just before you send us
+your PR.  There is also a make target to rewind this last build commit:
+
+.. code:: sh
+
+   make static.build.drop