History

Hossein ea5641baee 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>		2021-04-07 17:47:16 +02:00
..
.gitignore
config_box2d.h.in
config_buildid.h.in
config_cairo_canvas.h.in
config_clang.h.in
config_cxxabi.h.in
config_dbus.h.in
config_dconf.h.in
config_eot.h.in
config_extensions.h.in
config_feature_desktop.h.in
config_feature_opencl.h.in
config_features.h.in
config_firebird.h.in
config_folders.h.in
config_fuzzers.h.in
config_gio.h.in
config_global.h.in
config_gpgme.h.in
config_java.h.in
config_langs.h.in
config_lgpl.h.in
config_libcxx.h.in
config_liblangtag.h.in
config_locales.h.in
config_mpl.h.in
config_oauth2.h.in
config_oox.h.in
config_options.h.in
config_options_calc.h.in
config_poppler.h.in
config_probes.h.in
config_python.h.in
config_skia.h.in
config_typesizes.h.in
config_vcl.h.in
config_vclplug.h.in
config_vendor.h.in
config_version.h.in
config_writerperfect.h.in
config_zxing.h.in
README.md	Updated README.md files to represent current code / use Markdown format	2021-04-07 17:47:16 +02:00

README.md

C/C++ Configuration Created by configure Script

These are configuration files for various features as detected by configure.

Include only those files you need (in order to reduce rebuilds when a setting changes).

Settings here are only C/C++ #define directives, so they apply only to C/C++ source, not to Makefiles.

Adding a New Setting:

do AC_DEFINE(HAVE_FOO) in configure.ac when a setting should be set
choose the proper config_host/config_XXX.h file to use
- if it is a global setting (such as availability of a compiler feature), use config_host/config_global.h
- otherwise check if there is a matching config_host/config_XXX.h file
- if none matches, add a new one:
  - add config_host/config_XXX.h.in here, with just #ifndef include guard
  - add AC_CONFIG_HEADERS([config_host/config_XXX.h]) next to the others in configure.ac
add #define HAVE_FOO 0 to the config_host/config_XXX.h, possibly with a comment (do not use #undef HAVE_FOO, unless the setting has more values than on/off)
add #include <config_XXX.h> before any #if HAVE_FOO in a source file
make sure you use #if HAVE_FOO for on/off settings, do not use #ifdef