mirror of
https://git.postgresql.org/git/postgresql.git
synced 2024-09-11 07:53:21 +02:00
This unifies the various ad hoc logging (message printing, error printing) systems used throughout the command-line programs. Features: - Program name is automatically prefixed. - Message string does not end with newline. This removes a common source of inconsistencies and omissions. - Additionally, a final newline is automatically stripped, simplifying use of PQerrorMessage() etc., another common source of mistakes. - I converted error message strings to use %m where possible. - As a result of the above several points, more translatable message strings can be shared between different components and between frontends and backend, without gratuitous punctuation or whitespace differences. - There is support for setting a "log level". This is not meant to be user-facing, but can be used internally to implement debug or verbose modes. - Lazy argument evaluation, so no significant overhead if logging at some level is disabled. - Some color in the messages, similar to gcc and clang. Set PG_COLOR=auto to try it out. Some colors are predefined, but can be customized by setting PG_COLORS. - Common files (common/, fe_utils/, etc.) can handle logging much more simply by just using one API without worrying too much about the context of the calling program, requiring callbacks, or having to pass "progname" around everywhere. - Some programs called setvbuf() to make sure that stderr is unbuffered, even on Windows. But not all programs did that. This is now done centrally. Soft goals: - Reduces vertical space use and visual complexity of error reporting in the source code. - Encourages more deliberate classification of messages. For example, in some cases it wasn't clear without analyzing the surrounding code whether a message was meant as an error or just an info. - Concepts and terms are vaguely aligned with popular logging frameworks such as log4j and Python logging. This is all just about printing stuff out. Nothing affects program flow (e.g., fatal exits). The uses are just too varied to do that. Some existing code had wrappers that do some kind of print-and-exit, and I adapted those. I tried to keep the output mostly the same, but there is a lot of historical baggage to unwind and special cases to consider, and I might not always have succeeded. One significant change is that pg_rewind used to write all error messages to stdout. That is now changed to stderr. Reviewed-by: Donald Dong <xdong@csumb.edu> Reviewed-by: Arthur Zakirov <a.zakirov@postgrespro.ru> Discussion: https://www.postgresql.org/message-id/flat/6a609b43-4f57-7348-6480-bd022f924310@2ndquadrant.com
166 lines
6.2 KiB
Makefile
166 lines
6.2 KiB
Makefile
# src/nls-global.mk
|
|
|
|
# Common rules for Native Language Support (NLS)
|
|
#
|
|
# If some subdirectory of the source tree wants to provide NLS, it
|
|
# needs to contain a file 'nls.mk' with the following make variable
|
|
# assignments:
|
|
#
|
|
# CATALOG_NAME -- name of the message catalog (xxx.po); probably
|
|
# name of the program
|
|
# AVAIL_LANGUAGES -- list of languages that are provided/supported
|
|
# GETTEXT_FILES -- list of source files that contain message strings
|
|
# GETTEXT_TRIGGERS -- (optional) list of functions that contain
|
|
# translatable strings
|
|
# GETTEXT_FLAGS -- (optional) list of gettext --flag arguments to mark
|
|
# function arguments that contain C format strings
|
|
# (functions must be listed in TRIGGERS and FLAGS)
|
|
#
|
|
# That's all, the rest is done here, if --enable-nls was specified.
|
|
#
|
|
# The only user-visible targets here are 'init-po', to make an initial
|
|
# "blank" catalog from program sources, and 'update-po', which is to
|
|
# be called if the messages in the program source have changed, in
|
|
# order to merge the changes into the existing .po files.
|
|
|
|
|
|
# existence checked by Makefile.global; otherwise we won't get here
|
|
include $(srcdir)/nls.mk
|
|
|
|
# If user specified the languages he wants in --enable-nls=LANGUAGES,
|
|
# filter out the rest. Else use all available ones.
|
|
ifdef WANTED_LANGUAGES
|
|
LANGUAGES = $(filter $(WANTED_LANGUAGES), $(AVAIL_LANGUAGES))
|
|
else
|
|
LANGUAGES = $(AVAIL_LANGUAGES)
|
|
endif
|
|
|
|
PO_FILES = $(addprefix po/, $(addsuffix .po, $(LANGUAGES)))
|
|
ALL_PO_FILES = $(addprefix po/, $(addsuffix .po, $(AVAIL_LANGUAGES)))
|
|
MO_FILES = $(addprefix po/, $(addsuffix .mo, $(LANGUAGES)))
|
|
|
|
ifdef XGETTEXT
|
|
XGETTEXT += -ctranslator --copyright-holder='PostgreSQL Global Development Group' --msgid-bugs-address=pgsql-bugs@lists.postgresql.org --no-wrap --sort-by-file --package-name='$(CATALOG_NAME) (PostgreSQL)' --package-version='$(MAJORVERSION)'
|
|
endif
|
|
|
|
ifdef MSGMERGE
|
|
MSGMERGE += --no-wrap --previous --sort-by-file
|
|
endif
|
|
|
|
# _ is defined in c.h, so it's global
|
|
GETTEXT_TRIGGERS += _
|
|
GETTEXT_FLAGS += _:1:pass-c-format
|
|
|
|
|
|
# common settings that apply to backend and all backend modules
|
|
BACKEND_COMMON_GETTEXT_TRIGGERS = \
|
|
errmsg errmsg_plural:1,2 \
|
|
errdetail errdetail_log errdetail_plural:1,2 \
|
|
errhint \
|
|
errcontext \
|
|
XactLockTableWait:4 \
|
|
MultiXactIdWait:6 \
|
|
ConditionalMultiXactIdWait:6
|
|
BACKEND_COMMON_GETTEXT_FLAGS = \
|
|
errmsg:1:c-format errmsg_plural:1:c-format errmsg_plural:2:c-format \
|
|
errdetail:1:c-format errdetail_log:1:c-format errdetail_plural:1:c-format errdetail_plural:2:c-format \
|
|
errhint:1:c-format \
|
|
errcontext:1:c-format
|
|
|
|
FRONTEND_COMMON_GETTEXT_FILES = $(top_srcdir)/src/fe_utils/logging.c
|
|
|
|
FRONTEND_COMMON_GETTEXT_TRIGGERS = \
|
|
pg_log_fatal pg_log_error pg_log_warning pg_log_info pg_log_generic:2 pg_log_generic_v:2
|
|
|
|
FRONTEND_COMMON_GETTEXT_FLAGS = \
|
|
pg_log_fatal:1:c-format pg_log_error:1:c-format pg_log_warning:1:c-format pg_log_info:1:c-format pg_log_generic:2:c-format pg_log_generic_v:2:c-format
|
|
|
|
|
|
all-po: $(MO_FILES)
|
|
|
|
%.mo: %.po
|
|
$(MSGFMT) $(MSGFMT_FLAGS) -o $@ $<
|
|
|
|
ifeq ($(word 1,$(GETTEXT_FILES)),+)
|
|
po/$(CATALOG_NAME).pot: $(word 2, $(GETTEXT_FILES)) $(MAKEFILE_LIST)
|
|
ifdef XGETTEXT
|
|
$(XGETTEXT) -D $(srcdir) -D . -n $(addprefix -k, $(GETTEXT_TRIGGERS)) $(addprefix --flag=, $(GETTEXT_FLAGS)) -f $<
|
|
else
|
|
@echo "You don't have 'xgettext'."; exit 1
|
|
endif
|
|
else # GETTEXT_FILES
|
|
po/$(CATALOG_NAME).pot: $(GETTEXT_FILES) $(MAKEFILE_LIST)
|
|
# Change to srcdir explicitly, don't rely on $^. That way we get
|
|
# consistent #: file references in the po files.
|
|
ifdef XGETTEXT
|
|
$(XGETTEXT) -D $(srcdir) -D . -n $(addprefix -k, $(GETTEXT_TRIGGERS)) $(addprefix --flag=, $(GETTEXT_FLAGS)) $(GETTEXT_FILES)
|
|
else
|
|
@echo "You don't have 'xgettext'."; exit 1
|
|
endif
|
|
endif # GETTEXT_FILES
|
|
@$(MKDIR_P) $(dir $@)
|
|
sed -e '1,18 { s/SOME DESCRIPTIVE TITLE./LANGUAGE message translation file for $(CATALOG_NAME)/;s/PACKAGE/PostgreSQL/g;s/VERSION/$(MAJORVERSION)/g;s/YEAR/'`date +%Y`'/g; }' messages.po >$@
|
|
rm messages.po
|
|
|
|
|
|
# catalog name extensions must match behavior of PG_TEXTDOMAIN() in c.h
|
|
install-po: all-po installdirs-po
|
|
ifneq (,$(LANGUAGES))
|
|
for lang in $(LANGUAGES); do \
|
|
$(INSTALL_DATA) po/$$lang.mo '$(DESTDIR)$(localedir)'/$$lang/LC_MESSAGES/$(CATALOG_NAME)$(SO_MAJOR_VERSION)-$(MAJORVERSION).mo || exit 1; \
|
|
done
|
|
endif
|
|
|
|
installdirs-po:
|
|
$(if $(LANGUAGES),$(MKDIR_P) $(foreach lang, $(LANGUAGES), '$(DESTDIR)$(localedir)'/$(lang)/LC_MESSAGES),:)
|
|
|
|
uninstall-po:
|
|
$(if $(LANGUAGES),rm -f $(foreach lang, $(LANGUAGES), '$(DESTDIR)$(localedir)'/$(lang)/LC_MESSAGES/$(CATALOG_NAME)$(SO_MAJOR_VERSION)-$(MAJORVERSION).mo),:)
|
|
|
|
|
|
clean-po:
|
|
$(if $(MO_FILES),rm -f $(MO_FILES))
|
|
@$(if $(wildcard po/*.po.new),rm -f po/*.po.new)
|
|
rm -f po/$(CATALOG_NAME).pot
|
|
|
|
|
|
init-po: po/$(CATALOG_NAME).pot
|
|
|
|
|
|
# For performance reasons, only calculate these when the user actually
|
|
# requested update-po or a specific file.
|
|
ifneq (,$(filter update-po %.po.new,$(MAKECMDGOALS)))
|
|
ALL_LANGUAGES := $(shell find $(top_srcdir) -name '*.po' -print | sed 's,^.*/\([^/]*\).po$$,\1,' | LC_ALL=C sort -u)
|
|
all_compendia := $(shell find $(top_srcdir) -name '*.po' -print | LC_ALL=C sort)
|
|
else
|
|
ALL_LANGUAGES = $(AVAIL_LANGUAGES)
|
|
all_compendia = FORCE
|
|
FORCE:
|
|
endif
|
|
|
|
ifdef WANTED_LANGUAGES
|
|
ALL_LANGUAGES := $(filter $(WANTED_LANGUAGES), $(ALL_LANGUAGES))
|
|
endif
|
|
|
|
update-po: $(ALL_LANGUAGES:%=po/%.po.new)
|
|
|
|
$(AVAIL_LANGUAGES:%=po/%.po.new): po/%.po.new: po/%.po po/$(CATALOG_NAME).pot $(all_compendia)
|
|
$(MSGMERGE) --lang=$* $(word 1, $^) $(word 2,$^) -o $@ $(addprefix --compendium=,$(filter %/$*.po,$(wordlist 3,$(words $^),$^)))
|
|
|
|
# For languages not yet available, merge against oneself, to pick
|
|
# up translations from the compendia. (Merging against /dev/null
|
|
# doesn't work so well; it inserts the headers from the first-named
|
|
# compendium.)
|
|
po/%.po.new: po/$(CATALOG_NAME).pot $(all_compendia)
|
|
$(MSGMERGE) --lang=$* $(word 1,$^) $(word 1,$^) -o $@ $(addprefix --compendium=,$(filter %/$*.po,$(wordlist 2,$(words $^),$^)))
|
|
|
|
|
|
all: all-po
|
|
install: install-po
|
|
installdirs: installdirs-po
|
|
uninstall: uninstall-po
|
|
clean distclean maintainer-clean: clean-po
|
|
|
|
.PHONY: all-po install-po installdirs-po uninstall-po clean-po \
|
|
init-po update-po
|