emacs/gnu.emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2026-09-10 07:46:51 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Always build the Emacs, Elisp and Intro manuals (bug#81332)

Browse source 
The manuals in doc/emacs, doc/lispintro and doc/lispref have no
translations, so filtering the per-directory language list by DOCLANGS
left those directories with nothing to build when DOCLANGS does not
include 'default'.  These three manuals must be built and installed
regardless of DOCLANGS: the Emacs and Emacs Lisp manuals are
referenced from doc strings, and the Introduction to Emacs Lisp
Programming is an important enough part of Emacs to be available
whatever the language preferences of the user who builds the manuals.

* Makefile.in (MANDATORY_DOC_DIRS): New variable.
(FILTER_DOCLANGS): Use it to always build the default language for
those directories.
(INFO_NONMISC, srcdir_doc_info_dir_inputs): Say why these are not
gated by DOCLANGS.
* doc/translations/README: Document that those three manuals are
always built in the default language.
This commit is contained in:
Boris Buliga 2026-08-05 09:50:37 +03:00 committed by Eli Zaretskii
parent f4f249a224
commit 67efab7637
2 changed files with 24 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
Makefile.in
View file

@ -176,6 +176,7 @@ man1dir=$(mandir)/man1
# Where to install and expect the info files describing Emacs.
infodir=@infodir@
# Info files not in the doc/misc directory (we get those via make echo-info).
# These are not gated by DOCLANGS: see MANDATORY_DOC_DIRS below.
INFO_NONMISC=emacs.info eintr.info elisp.info
# Directory for local state files for all programs.
@ -1151,16 +1152,22 @@ $(1)-DOCLANG-$(2): $(1)-common
$$(MAKE) -C doc/$$(subst -, DOCLANG=$(2) ,$(1))
endef
## Directories whose manuals are always built in the default language,
## whatever DOCLANGS says: the Emacs and Emacs Lisp manuals are
## referenced from doc strings, and the Emacs Lisp Intro is an
## important enough part of Emacs to be available regardless of the
## language preferences of the user who builds the manuals.
MANDATORY_DOC_DIRS = emacs lispintro lispref
## Languages from DOCLANGS to build the manuals in doc/$(1) for: the
## default language (when in DOCLANGS), plus every other language in
## DOCLANGS that has translations for this directory
## (doc/translations/<lang>/$(1)). Directories without translations
## for a language must not run a sub-make for it: the doc Makefiles of
## untranslated directories ignore DOCLANG, so such a sub-make would
## just repeat the default-language build, and two sub-makes producing
## the same outputs race under "make -j" (e.g. "cp: cannot create
## regular file ...: File exists").
FILTER_DOCLANGS = $(filter $(DOCLANGS),default) $(foreach lang,$(filter-out default,$(DOCLANGS)),$(if $(wildcard ${srcdir}/doc/translations/$(lang)/$(1)),$(lang)))
## default language (when in DOCLANGS, or always for the directories
## above), plus every other language in DOCLANGS that has translations
## for this directory (doc/translations/<lang>/$(1)). Directories
## without translations for a language must not run a sub-make for it:
## the doc Makefiles of untranslated directories ignore DOCLANG, so
## such a sub-make would just repeat the default-language build, and
## two sub-makes producing the same outputs race under "make -j" (e.g.
## "cp: cannot create regular file ...: File exists").
FILTER_DOCLANGS = $(if $(filter $(1),$(MANDATORY_DOC_DIRS)),default,$(filter $(DOCLANGS),default)) $(foreach lang,$(filter-out default,$(DOCLANGS)),$(if $(wildcard ${srcdir}/doc/translations/$(lang)/$(1)),$(lang)))
# $(1) = doc target (e.g. lispintro-info), $(2) = languages to build
define MAKE_DOC
# Define a target to which dependencies common to all of the doc files
@ -1207,7 +1214,8 @@ $(foreach lang,$(DOCLANGS),$(eval $(call set_texi_misc,$(lang))))
## would break in a fresh checkout, because the .texi files of the
## org-based manuals (e.g. modus-themes.texi) are generated and there
## is no rule to build them at this level. make-info-dir extracts dir
## entries from both formats.
## entries from both formats. The first three are not gated by
## DOCLANGS, because MANDATORY_DOC_DIRS always builds them.
srcdir_doc_info_dir_inputs := \
${srcdir}/doc/emacs/emacs.texi \
${srcdir}/doc/lispintro/emacs-lisp-intro.texi \

6
doc/translations/README
View file

@ -38,6 +38,12 @@ of languages. ./configure --help for values supported. For instance:
to make all manuals from the misc subdirectory into the info format and
for language French only.
Note that the Emacs manual, the Emacs Lisp Reference manual and the
Introduction to Emacs Lisp Programming are always built in the default
language, whatever DOCLANGS says: the first two are referenced from doc
strings, and all three are expected to be part of any Emacs build.
Their translations, if any, are selected by DOCLANGS as usual.
Alternatively, you can use:
make -C doc/DIR FORMAT