summaryrefslogtreecommitdiff
path: root/docs/dev/quickstart.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-06-26 13:10:56 +0200
committerAlexandre Flament <alex@al-f.net>2021-06-28 10:22:06 +0200
commit5a979ff98773bbd4570b12e521173b881dd6da95 (patch)
tree5e65aa047bbba5731801de4ba10c92ab38a21ba3 /docs/dev/quickstart.rst
parent25b6309cf248a1c5c092780e98107d281999bd85 (diff)
downloadsearxng-5a979ff98773bbd4570b12e521173b881dd6da95.tar.gz
searxng-5a979ff98773bbd4570b12e521173b881dd6da95.zip
[docs] describe the usage of the static.build.* scripts
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/quickstart.rst')
-rw-r--r--docs/dev/quickstart.rst23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst
index 74bb52960..8132bccc4 100644
--- a/docs/dev/quickstart.rst
+++ b/docs/dev/quickstart.rst
@@ -29,7 +29,7 @@ If you implement themes, you will need to compile styles and JavaScript before
.. code:: sh
- make themes
+ make themes.all
Don't forget to install npm_ first.
@@ -53,3 +53,24 @@ Don't forget to install npm_ first.
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