summaryrefslogtreecommitdiff
path: root/solenv
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 /solenv
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 'solenv')
-rw-r--r--solenv/README.md50
1 files changed, 28 insertions, 22 deletions
diff --git a/solenv/README.md b/solenv/README.md
index b5a730746674..fd45397e2fb8 100644
--- a/solenv/README.md
+++ b/solenv/README.md
@@ -1,41 +1,47 @@
-Tools and makefile fragments necessary for compilation
+# Tools and Makefile Fragments Necessary for Compilation
This module contains many tools and makefile configuration pieces,
critical for building LibreOffice:
-bin/
- contains lots of tools used during the build:
+- `bin/`
- concat-deps*
- these aggregate, and remove duplicates from module
- dependencies, to accelerate build times.
+ - contains lots of tools used during the build:
- make_installer.pl
- this script executes the compiled instructions from
- the scp2/ module to create an installer, and/or to
- do a local install for the smoketest.
+ - `concat-deps*`
+ these aggregate, and remove duplicates from module
+ dependencies, to accelerate build times.
+
+ - `make_installer.pl`
+ this script executes the compiled instructions from
+ the `scp2/` module to create an installer, and/or to
+ do a local install for the smoketest.
+
+- `gbuild/`
-gbuild/
implementation of the LibreOffice build system
- See gbuild/README for more info.
+ See `gbuild/README` for more info.
+
+- `gdb/`
-gdb/
lots of nice python helpers to make debugging -much- easier
that (eg.) print UCS2 strings as UTF-8 on the console to
help with debugging.
-inc/
- old / increasingly obsolete dmake setup and includes, we are
+- `inc/`
+
+ old `/` increasingly obsolete dmake setup and includes, we are
trying to entirely rid ourselves of this
-src/
- useful standard / re-usable component map files for components
+- `src/`
+
+ useful standard `/` re-usable component map files for components
which shouldn't export anything more than a few registration
symbols.
-flatpak-manifest.in
- This file is used by flatpak/build.sh from the LO dev-tools
- repository to generate the flatpak package. download.lst is
- a Makefile snippet, so there seems to be no easy way to use
- download.lst for the manifest generation (build.sh uses sed),
+- `flatpak-manifest.in`
+
+ This file is used by `flatpak/build.sh` from the LO `dev-tools`
+ repository to generate the flatpak package. `download.lst` is
+ a `Makefile` snippet, so there seems to be no easy way to use
+ `download.lst` for the manifest generation (`build.sh` uses `sed`),
and its information must be kept in sync manually.