Recheck include/ with IWYU
[LibreOffice.git] / solenv / README.md
blobfd45397e2fb8b8cb6ecc4d7f8c7c4aa1f09bb193
1 # Tools and Makefile Fragments Necessary for Compilation
3 This module contains many tools and makefile configuration pieces,
4 critical for building LibreOffice:
6 - `bin/`
8     - contains lots of tools used during the build:
10         - `concat-deps*`
11             these aggregate, and remove duplicates from module
12             dependencies, to accelerate build times.
14         - `make_installer.pl`
15             this script executes the compiled instructions from
16             the `scp2/` module to create an installer, and/or to
17             do a local install for the smoketest.
19 - `gbuild/`
21     implementation of the LibreOffice build system
22     See `gbuild/README` for more info.
24 - `gdb/`
26     lots of nice python helpers to make debugging -much- easier
27     that (eg.) print UCS2 strings as UTF-8 on the console to
28     help with debugging.
30 - `inc/`
32     old `/` increasingly obsolete dmake setup and includes, we are
33     trying to entirely rid ourselves of this
35 - `src/`
37     useful standard `/` re-usable component map files for components
38     which shouldn't export anything more than a few registration
39     symbols.
41 - `flatpak-manifest.in`
43     This file is used by `flatpak/build.sh` from the LO `dev-tools`
44     repository to generate the flatpak package. `download.lst` is
45     a `Makefile` snippet, so there seems to be no easy way to use
46     `download.lst` for the manifest generation (`build.sh` uses `sed`),
47     and its information must be kept in sync manually.