summaryrefslogtreecommitdiff
path: root/distro-configs
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 /distro-configs
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 'distro-configs')
-rw-r--r--distro-configs/README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/distro-configs/README.md b/distro-configs/README.md
index 66a6e324d48a..7ae0450bfa31 100644
--- a/distro-configs/README.md
+++ b/distro-configs/README.md
@@ -1,28 +1,28 @@
-Pre-canned distribution configurations
+# 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
+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.)
+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:
+on the `autogen.sh` command line thus:
-./autogen.sh --with-distro=LibreOfficeFoo
+ ./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