summaryrefslogtreecommitdiff
path: root/distro-configs/README.md
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-23 14:20:32 +0430
committerChristian Lohmaier <lohmaier+LibreOffice@googlemail.com>2021-03-24 11:46:14 +0100
commitc16158772d64cab8a4ed1f165cab57d307998e78 (patch)
tree424f72af3b4a877ecb9493cd64de70e4925a9bee /distro-configs/README.md
parentea184837a54fc85599d78baf59c83b6cf8bd0adb (diff)
Using .md extension/Markdown syntax for modules README
Renaming all README files for all top level modules to README.md, applying no content change at this stage to be able to track history of the files. These files should be edited to use correct Markdown syntax later. Change-Id: I542fa3f3d32072156f16eaad2211a397cc212665 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/112977 Tested-by: Jenkins Reviewed-by: Christian Lohmaier <lohmaier+LibreOffice@googlemail.com>
Diffstat (limited to 'distro-configs/README.md')
-rw-r--r--distro-configs/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/distro-configs/README.md b/distro-configs/README.md
new file mode 100644
index 000000000000..66a6e324d48a
--- /dev/null
+++ b/distro-configs/README.md
@@ -0,0 +1,32 @@
+Pre-canned distribution configurations
+
+These files are supposed to correspond to the options used when
+creating the Document Foundation (or other "canonical") builds of
+LibreOffice for various platforms. They are *not* supposed to
+represent the "most useful" options for developers in general. On the
+contrary, the intent is that just running ./autogen.sh without any
+options at all should produce a buildable configuration for developers
+with interest in working on the most commonly used parts of the code.
+
+See [[https://wiki.documentfoundation.org/Development/ReleaseBuilds]] for how
+TDF builds make use of these switches. (Especially, since --with-package-format
+now triggers whether or not installation sets are built, all the relevant *.conf
+files specify it, except for LibreOfficeLinux.conf, where the TDF build
+instructions pass an explicit --with-package-format="rpm deb" in addition to
+--with-distro=LibreOfficeLinux.)
+
+(Possibly the above is a misunderstanding, or maybe there never even
+has been any clear consensus what situations these files actually are
+intended for.)
+
+The files contain sets of configuration parameters, and can be passed
+on the autogen.sh command line thus:
+
+./autogen.sh --with-distro=LibreOfficeFoo
+
+Contrary to the above, in the Android case the amount of parameters
+you just must use is so large, that for convenience it is always
+easiest to use the corresponding distro-configs file. This is a bug
+and needs to be fixed; also configuring for Android should ideally use
+sane (or the only possible) defaults and work fine without any
+parameters at all.