diff options
Diffstat (limited to 'solenv')
-rw-r--r-- | solenv/README.md | 50 |
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. |