summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDariusz Michaluk <d.michaluk@samsung.com>2023-01-17 10:10:58 +0100
committerDariusz Michaluk <d.michaluk@samsung.com>2023-01-17 10:10:58 +0100
commit271dd294788018e36d221dd3f0d5114913117dc2 (patch)
tree7cdba05d90c3aefd4fff3752f9b180ee537f0f30 /doc
parentd19ea645c3fa6a08d65c25272e55de7522f83732 (diff)
downloadlibgpg-error-271dd294788018e36d221dd3f0d5114913117dc2.tar.gz
libgpg-error-271dd294788018e36d221dd3f0d5114913117dc2.tar.bz2
libgpg-error-271dd294788018e36d221dd3f0d5114913117dc2.zip
Imported Upstream version 1.46upstream/1.46
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am6
-rw-r--r--doc/Makefile.in22
-rw-r--r--doc/gpgrt.info129
-rw-r--r--doc/gpgrt.texi91
-rw-r--r--doc/stamp-vti8
-rw-r--r--doc/version.texi8
-rw-r--r--doc/yat2m.c5
7 files changed, 141 insertions, 128 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 46b4545..db34ba9 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -33,7 +33,11 @@ YAT2M_OPTIONS = -I $(srcdir) \
--release "Libgpg-error @PACKAGE_VERSION@" --source "GnuPG"
myman_sources = gpgrt.texi
-myman_pages = gpgrt-config.1
+if INSTALL_GPG_ERROR_CONFIG
+myman_pages = gpg-error-config.1
+else
+myman_pages =
+endif
man_MANS = $(myman_pages)
diff --git a/doc/Makefile.in b/doc/Makefile.in
index 96563d0..2d5029f 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -114,14 +114,15 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/autobuild.m4 \
$(top_srcdir)/m4/ax_cc_for_build.m4 \
$(top_srcdir)/m4/codeset.m4 $(top_srcdir)/m4/estream.m4 \
$(top_srcdir)/m4/gettext.m4 $(top_srcdir)/m4/gnupg-misc.m4 \
- $(top_srcdir)/m4/iconv.m4 $(top_srcdir)/m4/lib-ld.m4 \
- $(top_srcdir)/m4/lib-link.m4 $(top_srcdir)/m4/lib-prefix.m4 \
- $(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/lock.m4 \
- $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \
- $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \
- $(top_srcdir)/m4/nls.m4 $(top_srcdir)/m4/po.m4 \
- $(top_srcdir)/m4/progtest.m4 $(top_srcdir)/m4/readline.m4 \
- $(top_srcdir)/m4/threadlib.m4 $(top_srcdir)/configure.ac
+ $(top_srcdir)/m4/host-cpu-c-abi.m4 $(top_srcdir)/m4/iconv.m4 \
+ $(top_srcdir)/m4/lib-ld.m4 $(top_srcdir)/m4/lib-link.m4 \
+ $(top_srcdir)/m4/lib-prefix.m4 $(top_srcdir)/m4/libtool.m4 \
+ $(top_srcdir)/m4/lock.m4 $(top_srcdir)/m4/ltoptions.m4 \
+ $(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \
+ $(top_srcdir)/m4/lt~obsolete.m4 $(top_srcdir)/m4/nls.m4 \
+ $(top_srcdir)/m4/po.m4 $(top_srcdir)/m4/progtest.m4 \
+ $(top_srcdir)/m4/readline.m4 $(top_srcdir)/m4/threadlib.m4 \
+ $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/version.texi \
@@ -361,8 +362,8 @@ MAKEINFO = @MAKEINFO@
MANIFEST_TOOL = @MANIFEST_TOOL@
MKDIR_P = @MKDIR_P@
MSGFMT = @MSGFMT@
-MSGFMT_015 = @MSGFMT_015@
MSGMERGE = @MSGMERGE@
+MSGMERGE_FOR_MSGFMT_OPTION = @MSGMERGE_FOR_MSGFMT_OPTION@
NM = @NM@
NMEDIT = @NMEDIT@
OBJDUMP = @OBJDUMP@
@@ -454,7 +455,8 @@ YAT2M_OPTIONS = -I $(srcdir) \
--release "Libgpg-error @PACKAGE_VERSION@" --source "GnuPG"
myman_sources = gpgrt.texi
-myman_pages = gpgrt-config.1
+@INSTALL_GPG_ERROR_CONFIG_FALSE@myman_pages =
+@INSTALL_GPG_ERROR_CONFIG_TRUE@myman_pages = gpg-error-config.1
man_MANS = $(myman_pages)
@CROSS_COMPILING_FALSE@YAT2M_CMD = ./yat2m$(EXEEXT)
@CROSS_COMPILING_TRUE@YAT2M_CMD = ./yat2m-for-build$(EXEEXT_FOR_BUILD)
diff --git a/doc/gpgrt.info b/doc/gpgrt.info
index 0e7dfbe..caa97dd 100644
--- a/doc/gpgrt.info
+++ b/doc/gpgrt.info
@@ -1,9 +1,9 @@
This is gpgrt.info, produced by makeinfo version 6.5 from gpgrt.texi.
-This manual is for Libgpg-error (version 1.43, 7 December 2018), which
-is a library for code used by all GnuPG related packages.
+This manual is for Libgpg-error (version 1.46, 2 August 2022), which is
+a library for code used by all GnuPG related packages.
-Copyright (C) 2014 g10 Code GmbH
+Copyright (C) 2014, 2022 g10 Code GmbH
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License as
@@ -13,7 +13,7 @@ Copyright (C) 2014 g10 Code GmbH
License".
INFO-DIR-SECTION Libraries
START-INFO-DIR-ENTRY
-* libgpg-error: (gnupg). Error codes and common code for GnuPG.
+* libgpg-error: (gpgrt). Error codes and common code for GnuPG.
END-INFO-DIR-ENTRY

@@ -22,10 +22,10 @@ File: gpgrt.info, Node: Top, Next: Introduction, Up: (dir)
The Libgpg-error Library
************************
-This manual is for Libgpg-error (version 1.43, 7 December 2018), which
-is a library for code used by all GnuPG related packages.
+This manual is for Libgpg-error (version 1.46, 2 August 2022), which is
+a library for code used by all GnuPG related packages.
-Copyright (C) 2014 g10 Code GmbH
+Copyright (C) 2014, 2022 g10 Code GmbH
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License as
@@ -126,11 +126,11 @@ File: gpgrt.info, Node: Header, Next: Building sources, Up: Preparation
==========
All interfaces (data types and functions) of the library are defined in
-the header file 'libgpg-error.h'. You must include this in all source
+the header file 'gpg-error.h'. You must include this in all source
files using the library, either directly or through some other header
file, like this:
- #include <libgpg-error.h>
+ #include <gpg-error.h>
Note well that the header file is platform specific and may only be
used on the platform for which it has been build.
@@ -162,32 +162,41 @@ which the header file is located to the compilers include file search
path (via the '-I' option).
However, the path to the include file is determined at the time the
-source is configured. To solve this problem, Libgpg-error ships with
-the small helper program 'gpgrt-config' which know the path to the
-include file and other configuration options. The options that need to
-be added to the compiler invocation at compile time are output by the
-'--cflags' option to 'gpgrt-config' The following example shows how it
-can be used at the command line:
+source is configured. To solve this problem, Libgpg-error ships with a
+pkg-config file: gpg-error.pc.
- gcc -c foo.c $(gpgrt-config --cflags)
+ The options that need to be added to the compiler invocation at
+compile time are output by the '--cflags' option to 'pkg-config'. The
+following example shows how it can be used at the command line:
- Adding the output of 'gpgrt-config --cflags' to the compiler’s
-command line will ensure that the compiler can find the Libgpg-error
-header file.
+ gcc -c foo.c $(pkg-config --cflags gpg-error)
+
+ Adding the output of 'pkg-config --cflags gpg-error' to the
+compiler’s command line will ensure that the compiler can find the
+Libgpg-error header file.
A similar problem occurs when linking the program with the library.
Again, the compiler has to find the library files. For this to work,
the path to the library files has to be added to the library search path
-(via the '-L' option). For this, the option '--libs' to 'gpgrt-config'
+(via the '-L' option). For this, the option '--libs' to 'pkg-config'
can be used. The example shows how to link 'foo.o' with the
Libgpg-error library to a program 'foo'.
- gcc -o foo foo.o $(gpgrt-config --libs)
+ gcc -o foo foo.o $(pkg-config --libs gpg-error)
Of course you can also combine both examples to a single command by
-specifying both options to 'gpgrt-config':
+specifying both options to 'pkg-config':
+
+ gcc -o foo foo.c $(pkg-config --cflags --libs gpg-error)
- gcc -o foo foo.c $(gpgrt-config --cflags --libs)
+ For GnuPG and its friends, which are usually needed to be built
+earlier in a stage of OS bootstrap, Libgpg-error ships the small helper
+program 'gpgrt-config'. This helper program is a sort of 'pkg-config'
+replacement for limited environment, supporting cross compilation, as
+well as multilib and multi-arch installation. Note that 'gpgrt-config'
+is not for general use for other programs. 'gpgrt-config' requires
+invocation with the option '--lib=' so that it locates the appropriate
+path to 'gpg-error.pc'.

File: gpgrt.info, Node: Building sources using Automake, Next: Initializing the library, Prev: Building sources, Up: Preparation
@@ -197,8 +206,9 @@ File: gpgrt.info, Node: Building sources using Automake, Next: Initializing th
It is much easier if you use GNU Automake instead of writing your own
Makefiles. If you do that, you do not have to worry about finding and
-invoking the 'gpgrt-config' script at all. Libgpg-error provides an
-extension to Automake that does all the work for you.
+invoking the 'pkg-config' or 'gpgrt-config' script at all. Libgpg-error
+provides an extension to Automake that does all the work for you. That
+is offered by 'gpg-error.m4'.
-- Macro: AM_PATH_GPG_ERROR ([MINIMUM-VERSION], [ACTION-IF-FOUND],
[ACTION-IF-NOT-FOUND])
@@ -209,19 +219,9 @@ extension to Automake that does all the work for you.
Additionally, the function defines 'GPG_ERROR_CFLAGS' to the flags
needed for compilation of the program to find the 'gpg-error.h'
header file, and 'GPG_ERROR_LIBS' to the linker flags needed to
- link the program to the Libgpg-error library. If the used helper
- script does not match the target type you are building for a
- warning is printed and the string 'libgpg-error' is appended to the
- variable 'gpg_config_script_warn'.
-
- This macro searches for 'gpgrt-config' along the PATH. If you are
- cross-compiling, it is useful to set the environment variable
- 'SYSROOT' to the top directory of your target. The macro will then
- first look for the helper program in the 'bin' directory below that
- top directory. An absolute directory name must be used for
- 'SYSROOT'. Finally, if the configure command line option
- '--with-libgpg-error-prefix' is used, only its value is used for
- the top directory below which the helper script is expected.
+ link the program to the Libgpg-error library.
+
+ This macro searches for 'gpgrt-config' along the PATH.
You can use the defined Autoconf variables like this in your
'Makefile.am':
@@ -279,20 +279,23 @@ File: gpgrt.info, Node: Tools, Next: Library Copying, Prev: Generalities, Up
* Menu:
-* gpgrt-config:: Print required compiler flags
+* gpg-error-config:: Print required compiler flags

-File: gpgrt.info, Node: gpgrt-config, Up: Tools
+File: gpgrt.info, Node: gpg-error-config, Up: Tools
4.1 Print required compiler flags
=================================
-'gpgrt-config' is a tool that is used to configure to determine the
+'gpg-error-config' is a tool that is used to configure to determine the
compiler and linker flags that should be used to compile and link
-programs that use Libgpg-error. It is also used internally to the '.m4'
-macros for GNU autoconf that are included with Libgpg-error.
+programs that use Libgpg-error.
+
+ This tool is now obsolete. Instead, please use pkg-config with
+gpg-error.pc for your new program, or use gpg-error.m4 which uses
+gpgrt-config and gpg-error.pc internally.
-'gpgrt-config' accepts the following options:
+'gpg-error-config' accepts the following options:
'--mt'
Provide output appropriate for multithreaded programs. '--mt' is
@@ -1233,30 +1236,30 @@ Function and Data Index
* Menu:
* AM_PATH_GPG_ERROR: Building sources using Automake.
- (line 11)
+ (line 12)
* gpgrt_check_version: Initializing the library.
(line 15)

Tag Table:
-Node: Top729
-Node: Introduction2103
-Node: Getting Started2625
-Node: Features2982
-Node: Overview3111
-Node: Preparation3307
-Node: Header4108
-Node: Building sources5193
-Node: Building sources using Automake6924
-Node: Initializing the library8861
-Node: Multi-Threading10049
-Node: Generalities10191
-Node: Tools10378
-Node: gpgrt-config10544
-Node: Library Copying12111
-Node: Copying40212
-Node: Concept Index59382
-Node: Function and Data Index59679
+Node: Top733
+Node: Introduction2111
+Node: Getting Started2633
+Node: Features2990
+Node: Overview3119
+Node: Preparation3315
+Node: Header4116
+Node: Building sources5195
+Node: Building sources using Automake7393
+Node: Initializing the library8695
+Node: Multi-Threading9883
+Node: Generalities10025
+Node: Tools10212
+Node: gpg-error-config10382
+Node: Library Copying12035
+Node: Copying40136
+Node: Concept Index59306
+Node: Function and Data Index59603

End Tag Table
diff --git a/doc/gpgrt.texi b/doc/gpgrt.texi
index d4a3b41..2478366 100644
--- a/doc/gpgrt.texi
+++ b/doc/gpgrt.texi
@@ -13,7 +13,7 @@ This manual is for Libgpg-error (version @value{VERSION},
related packages.
@noindent
-Copyright @copyright{} 2014 g10 Code GmbH
+Copyright @copyright{} 2014, 2022 g10 Code GmbH
@quotation
Permission is granted to copy, distribute and/or modify this document
@@ -26,7 +26,7 @@ section entitled ``GNU General Public License''.
@dircategory Libraries
@direntry
-* libgpg-error: (gnupg). Error codes and common code for GnuPG.
+* libgpg-error: (gpgrt). Error codes and common code for GnuPG.
@end direntry
@c A couple of macros with no effect on texinfo
@@ -170,12 +170,12 @@ of the library are verified.
@section Header
All interfaces (data types and functions) of the library are defined
-in the header file @file{libgpg-error.h}. You must include this in all source
+in the header file @file{gpg-error.h}. You must include this in all source
files using the library, either directly or through some other header
file, like this:
@example
-#include <libgpg-error.h>
+#include <gpg-error.h>
@end example
Note well that the header file is platform specific and may only be
@@ -210,19 +210,18 @@ file search path (via the @option{-I} option).
However, the path to the include file is determined at the time the
source is configured. To solve this problem, Libgpg-error ships with
-the small helper program @command{gpgrt-config}
-which know the path to the include file
-and other configuration options. The options that need to be added to
-the compiler invocation at compile time are output by the
-@option{--cflags} option to @command{gpgrt-config}
-The following example shows how it can be
-used at the command line:
+a pkg-config file: gpg-error.pc.
+
+The options that need to be added to the compiler invocation at
+compile time are output by the @option{--cflags} option to
+@command{pkg-config}. The following example shows how it can be used
+at the command line:
@example
-gcc -c foo.c $(gpgrt-config --cflags)
+gcc -c foo.c $(pkg-config --cflags gpg-error)
@end example
-Adding the output of @samp{gpgrt-config --cflags} to the
+Adding the output of @samp{pkg-config --cflags gpg-error} to the
compiler’s command line will ensure that the compiler can find the
Libgpg-error header file.
@@ -230,28 +229,40 @@ A similar problem occurs when linking the program with the library.
Again, the compiler has to find the library files. For this to work,
the path to the library files has to be added to the library search
path (via the @option{-L} option). For this, the option
-@option{--libs} to @command{gpgrt-config} can be used. The
-example shows how to link @file{foo.o} with the Libgpg-error library
-to a program @command{foo}.
+@option{--libs} to @command{pkg-config} can be used. The example
+shows how to link @file{foo.o} with the Libgpg-error library to a
+program @command{foo}.
@example
-gcc -o foo foo.o $(gpgrt-config --libs)
+gcc -o foo foo.o $(pkg-config --libs gpg-error)
@end example
Of course you can also combine both examples to a single command by
-specifying both options to @command{gpgrt-config}:
+specifying both options to @command{pkg-config}:
@example
-gcc -o foo foo.c $(gpgrt-config --cflags --libs)
+gcc -o foo foo.c $(pkg-config --cflags --libs gpg-error)
@end example
+For GnuPG and its friends, which are usually needed to be built
+earlier in a stage of OS bootstrap, Libgpg-error ships the small
+helper program @command{gpgrt-config}. This helper program is a sort
+of @command{pkg-config} replacement for limited environment,
+supporting cross compilation, as well as multilib and multi-arch
+installation. Note that @command{gpgrt-config} is not for general use
+for other programs. @command{gpgrt-config} requires invocation with
+the option @option{--lib=} so that it locates the appropriate path to
+@file{gpg-error.pc}.
+
+
@node Building sources using Automake
@section Building sources using Automake
It is much easier if you use GNU Automake instead of writing your own
Makefiles. If you do that, you do not have to worry about finding and
-invoking the @command{gpgrt-config} script at all. Libgpg-error
-provides an extension to Automake that does all the work for you.
+invoking the @command{pkg-config} or @command{gpgrt-config} script at
+all. Libgpg-error provides an extension to Automake that does all the
+work for you. That is offered by @file{gpg-error.m4}.
@c A simple macro for optional variables.
@macro ovar{varname}
@@ -266,19 +277,9 @@ given.
Additionally, the function defines @code{GPG_ERROR_CFLAGS} to the
flags needed for compilation of the program to find the
@file{gpg-error.h} header file, and @code{GPG_ERROR_LIBS} to the
-linker flags needed to link the program to the Libgpg-error library. If
-the used helper script does not match the target type you are building
-for a warning is printed and the string @code{libgpg-error} is
-appended to the variable @code{gpg_config_script_warn}.
-
-This macro searches for @command{gpgrt-config} along the PATH. If
-you are cross-compiling, it is useful to set the environment variable
-@code{SYSROOT} to the top directory of your target. The macro will
-then first look for the helper program in the @file{bin} directory
-below that top directory. An absolute directory name must be used for
-@code{SYSROOT}. Finally, if the configure command line option
-@code{--with-libgpg-error-prefix} is used, only its value is used for
-the top directory below which the helper script is expected.
+linker flags needed to link the program to the Libgpg-error library.
+
+This macro searches for @command{gpgrt-config} along the PATH.
@end defmac
@@ -340,35 +341,37 @@ TBD. (Description of the error function may be taken from Libgcrypt.)
@chapter Tools
@menu
-* gpgrt-config:: Print required compiler flags
+* gpg-error-config:: Print required compiler flags
@end menu
@c The original version of this man page has been written for Debian and was
@c contributed to libgpg-error by Daniel Kahn Gillmor <dkg@fifthhorseman.net>.
-@manpage gpgrt-config.1
-@node gpgrt-config
+@manpage gpg-error-config.1
+@node gpg-error-config
@section Print required compiler flags
@ifset manverb
-.B gpgrt-config
+.B gpg-error-config
\- Script to get information about the installed version of libgpg-error
@end ifset
@mansect synopsis
@ifset manverb
-.B gpgrt-config
+.B gpg-error-config
.RI [ options ]
@end ifset
@mansect description
-@command{gpgrt-config} is a tool that is used to configure to
+@command{gpg-error-config} is a tool that is used to configure to
determine the compiler and linker flags that should be used to compile
-and link programs that use Libgpg-error. It is also used
-internally to the @code{.m4} macros for GNU autoconf that are included
-with Libgpg-error.
+and link programs that use Libgpg-error.
+
+This tool is now obsolete. Instead, please use pkg-config with
+gpg-error.pc for your new program, or use gpg-error.m4 which uses
+gpgrt-config and gpg-error.pc internally.
@mansect options
@noindent
-@command{gpgrt-config} accepts the following options:
+@command{gpg-error-config} accepts the following options:
@table @gnupgtabopt
diff --git a/doc/stamp-vti b/doc/stamp-vti
index e50742e..ba8846e 100644
--- a/doc/stamp-vti
+++ b/doc/stamp-vti
@@ -1,4 +1,4 @@
-@set UPDATED 7 December 2018
-@set UPDATED-MONTH December 2018
-@set EDITION 1.43
-@set VERSION 1.43
+@set UPDATED 2 August 2022
+@set UPDATED-MONTH August 2022
+@set EDITION 1.46
+@set VERSION 1.46
diff --git a/doc/version.texi b/doc/version.texi
index e50742e..ba8846e 100644
--- a/doc/version.texi
+++ b/doc/version.texi
@@ -1,4 +1,4 @@
-@set UPDATED 7 December 2018
-@set UPDATED-MONTH December 2018
-@set EDITION 1.43
-@set VERSION 1.43
+@set UPDATED 2 August 2022
+@set UPDATED-MONTH August 2022
+@set EDITION 1.46
+@set VERSION 1.46
diff --git a/doc/yat2m.c b/doc/yat2m.c
index 10e03ec..c2806e3 100644
--- a/doc/yat2m.c
+++ b/doc/yat2m.c
@@ -114,7 +114,7 @@
#if MY_GCC_VERSION >= 20500
# define ATTR_PRINTF(f, a) __attribute__ ((format(printf,f,a)))
-# define ATTR_NR_PRINTF(f, a) __attribute__ ((noreturn, format(printf,f,a)))
+# define ATTR_NR_PRINTF(f, a) __attribute__ ((__noreturn__, format(printf,f,a)))
#else
# define ATTR_PRINTF(f, a)
# define ATTR_NR_PRINTF(f, a)
@@ -1323,7 +1323,8 @@ finish_page (void)
}
else if (opt_store)
{
- inf ("writing '%s'", thepage.name );
+ if (verbose)
+ inf ("writing '%s'", thepage.name );
fp = fopen ( thepage.name, "w" );
if (!fp)
die ("failed to create '%s': %s\n", thepage.name, strerror (errno));