summaryrefslogtreecommitdiff
path: root/onlineupdate
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /onlineupdate
parent33da78c21f4243a3e469fb7df79ed1745df70078 (diff)
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md and now, the contents of these files were changed to use Markdown format. Other than format inconsistency, some README.md files lacked information about modules, or were out of date. By using LibreOffice / OpenOffice wiki and other documentation websites, these files were updated. Now every README.md file has a title, and some description. The top-level README.md file is changed to add links to the modules. The result of processing the Markdown format README.md files can be seen at: https://docs.libreoffice.org/ Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424 Tested-by: Jenkins Reviewed-by: Michael Stahl <michael.stahl@allotropia.de> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'onlineupdate')
-rw-r--r--onlineupdate/README.md35
1 files changed, 24 insertions, 11 deletions
diff --git a/onlineupdate/README.md b/onlineupdate/README.md
index 485a718499b3..0162776a618c 100644
--- a/onlineupdate/README.md
+++ b/onlineupdate/README.md
@@ -1,25 +1,38 @@
+# Online Update
+
Online update implementation based on Mozilla's MAR format + update mechanism
Parts of this code are copied from the mozilla repository, and adapted to
LibreOffice needs:
-firefox/modules/libmar -> onlineupdate/source/libmar
-firefox/toolkit/mozapps/update -> onlineupdate/source/update
+`firefox/modules/libmar` -> `onlineupdate/source/libmar`
+`firefox/toolkit/mozapps/update` -> `onlineupdate/source/update`
+
+The source/service directory contains the code for the silent windows updater that avoids the
+repeated administrator check for an update.
-The source/service directory contains the code for the silent windows updater that avoids the repeated administrator check for an update.
+## Note
-== NOTE ==
-The updater executable should not depend on any other dynamic library in the LibreOffice installation as we would need to copy that one also to a temporary directory during update. We can't update any library or executable that is currently in use. For the updater executable we solve this problem by copying the updater before using it to a temporary directory.
+The updater executable should not depend on any other dynamic library in the LibreOffice
+installation as we would need to copy that one also to a temporary directory during update. We can't
+update any library or executable that is currently in use. For the updater executable we solve this
+problem by copying the updater before using it to a temporary directory.
On Windows we use the system to provide us with a crypto library whereas on Linux we use NSS.
-== Update procedure ==
+## Update Procedure
-The updater executable is run two times. In a first run, the current installation is copied to a "update" directory and the update is applied in this "update" directory. During the next run, a replacement request is executed. The replacement request removes the old installation directory and replaces it with the content of the "update" directory.
+The updater executable is run two times. In a first run, the current installation is copied to an
+`update` directory and the update is applied in this `update` directory. During the next run, a
+replacement request is executed. The replacement request removes the old installation directory and
+replaces it with the content of the `update` directory.
-=== User profile in the installation directory ===
+### User Profile in the Installation Directory
-The archive based installations have the user profile by default inside of the installation directory. During the update process this causes some problems that need special handling in the updater.
+The archive based installations have the user profile by default inside of the installation
+directory. During the update process this causes some problems that need special handling in the
+updater.
-* The "update" directory is inside of the user profile resulting in recursive copying.
-* During the replacement request the updater log is in the user profile, which changes location from the actual location to a backup location.
+* The `update` directory is inside of the user profile resulting in recursive copying.
+* During the replacement request the updater log is in the user profile, which changes location from
+the actual location to a backup location.