1
0
mirror of https://github.com/weechat/weechat.git synced 2026-07-08 10:43:13 +02:00

doc: stop build of docs if a locale is missing, add CMake option "ENABLE_DOC_WARN_LOCALE" (closes #1985)

This commit is contained in:
Sébastien Helleu
2023-07-31 21:27:16 +02:00
parent 1ffd0a58b9
commit 8bfd25e2e6
5 changed files with 109 additions and 36 deletions
+31
View File
@@ -62,6 +62,37 @@ You can reset it with this command:
/reset weechat.key_mouse.@chat(fset.fset):button1
----
[[v4.1.0_doc_locales]]
=== Required locales for auto-generated docs
The build of auto-generated files for docs now requires all locales to be installed. +
If at least one locale is not installed, the following error is displayed:
----
doc generator: ERROR: failed to set locale "de_DE.UTF-8", these locales must be installed to build docs:
de_DE.UTF-8
en_US.UTF-8
fr_FR.UTF-8
it_IT.UTF-8
ja_JP.UTF-8
pl_PL.UTF-8
sr_RS.UTF-8
doc generator: you can turn this error as a warning with the cmake option ENABLE_DOC_WARN_LOCALE
----
A new CMake option "ENABLE_DOC_WARN_LOCALE" has been added to allow the build
of docs even if locales are missing:
----
cmake .. -DENABLE_DOC_WARN_LOCALE=ON
----
When this option is enabled, such warning is displayed and the doc is built anyway:
----
doc generator: WARNING: failed to set locale "de_DE.UTF-8", docs will include auto-generated English content
----
[[v4.0.2]]
== Version 4.0.2 (2023-07-12)