[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
doc: Update documentation about 'progname' module
From: |
Bruno Haible |
Subject: |
doc: Update documentation about 'progname' module |
Date: |
Sun, 06 Jan 2019 17:00:39 +0100 |
User-agent: |
KMail/5.1.3 (Linux/4.4.0-141-generic; KDE/5.18.0; x86_64; ; ) |
The documentation section "error and progname" is not up-to-date any more,
since 'error' was changed to use 'getprogname()' on 2016-09-05. This patch
fixes it.
2019-01-06 Bruno Haible <address@hidden>
doc: Update documentation about 'progname' module.
* doc/progname.texi: Rename from doc/error.texi. Change node name and
title. Rewrite.
* doc/gnulib.texi (Particular Modules): Update.
diff --git a/doc/error.texi b/doc/error.texi
deleted file mode 100644
index e450388..0000000
--- a/doc/error.texi
+++ /dev/null
@@ -1,26 +0,0 @@
address@hidden error and progname
address@hidden error and progname
address@hidden error
address@hidden progname
address@hidden program_name
-
address@hidden Copyright (C) 2007, 2009-2019 Free Software Foundation, Inc.
-
address@hidden Permission is granted to copy, distribute and/or modify this
document
address@hidden under the terms of the GNU Free Documentation License, Version
1.3 or
address@hidden any later version published by the Free Software Foundation;
with no
address@hidden Invariant Sections, no Front-Cover Texts, and no Back-Cover
address@hidden Texts. A copy of the license is included in the ``GNU Free
address@hidden Documentation License'' file as part of this distribution.
-
-The @code{error} function uses the @code{program_name} variable, but
-does not depend on the @code{progname} module. Why? Because
address@hidden is released under the LGPL, whereas @code{progname} is
-GPL. RMS does not want additional baggage accompanying the
address@hidden module, so an LGPL user must provide their own
-replacement @code{program_name}, and a GPL user should manually
-specify using the @code{progname} module.
-
-Additionally, using the @code{progname} module is not something that
-can be done implicitly. It requires that every @code{main} function
-be modified to set @code{program_name} as one of its first actions.
diff --git a/doc/progname.texi b/doc/progname.texi
new file mode 100644
index 0000000..13c9c7b
--- /dev/null
+++ b/doc/progname.texi
@@ -0,0 +1,33 @@
address@hidden progname and getprogname
address@hidden progname and getprogname
+
address@hidden Copyright (C) 2007, 2009-2019 Free Software Foundation, Inc.
+
address@hidden Permission is granted to copy, distribute and/or modify this
document
address@hidden under the terms of the GNU Free Documentation License, Version
1.3 or
address@hidden any later version published by the Free Software Foundation;
with no
address@hidden Invariant Sections, no Front-Cover Texts, and no Back-Cover
address@hidden Texts. A copy of the license is included in the ``GNU Free
address@hidden Documentation License'' file as part of this distribution.
+
+Gnulib has two modules for retrieving the name of the currently executing
+program: @code{progname} and @code{getprogname}.
+
address@hidden progname
address@hidden program_name
+The @code{progname} module defines a variable @code{program_name}.
+It contains the name of the currently executing program, on all platforms.
+But it cannot be used implicitly: It requires that every @code{main}
+function be modified to invoke @code{set_program_name (argv[0])} as one
+of its first actions.
+
address@hidden getprogname
+The @code{getprogname} module defines a function @code{getprogname()}.
+It returns the name of the currently executing program, on most platforms.
+The advantage of this module is that it can be used without prior
+initializations. But it has limitations: In some rare situations, it
+cannot determine the name; then it returns @code{"?"} instead. And on
+some platforms, it returns a truncated program name.
+
address@hidden error
+The @code{error} function uses the @code{getprogname} module.
diff --git a/doc/gnulib.texi b/doc/gnulib.texi
index ef1cda3..4378668 100644
--- a/doc/gnulib.texi
+++ b/doc/gnulib.texi
@@ -6368,7 +6368,7 @@ to POSIX that it can be treated like any other Unix-like
platform.
* Closed standard fds::
* String Functions in C Locale::
* Quoting::
-* error and progname::
+* progname and getprogname::
* gcd::
* Profiling of program phases::
* Library version handling::
@@ -6401,7 +6401,7 @@ to POSIX that it can be treated like any other Unix-like
platform.
@include quote.texi
address@hidden error.texi
address@hidden progname.texi
@include gcd.texi
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- doc: Update documentation about 'progname' module,
Bruno Haible <=