Merge branch '1436-docs-muckery' into 'master'

Fix various documentation issues and man page issues with autotools

See merge request GNOME/glib!209
This commit is contained in:
Matthias Clasen 2018-07-30 22:24:26 +00:00
commit dbf9959d15
16 changed files with 82 additions and 55 deletions

View File

@ -232,8 +232,6 @@ endif
CLEANFILES ?=
CLEANFILES += $(man_MANS)
EXTRA_DIST += $(man_MANS)
dist-hook-local: all-local
gio-docs-clean: clean

View File

@ -140,8 +140,6 @@ endif
CLEANFILES ?=
CLEANFILES += $(man_MANS)
EXTRA_DIST += $(man_MANS)
dist-hook-local: all-local
glib-docs-clean: clean

View File

@ -260,6 +260,10 @@
<title>Index of new symbols in 2.56</title>
<xi:include href="xml/api-index-2.56.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-2-58" role="2.58">
<title>Index of new symbols in 2.58</title>
<xi:include href="xml/api-index-2.58.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>

View File

@ -3482,15 +3482,15 @@ g_rc_box_get_size
<SECTION>
<FILE>arcbox</FILE>
g_arc_box_alloc
g_arc_box_alloc0
g_arc_box_new
g_arc_box_new0
g_arc_box_dup
g_arc_box_acquire
g_arc_box_release
g_arc_box_release_full
g_arc_box_get_size
g_atomic_rc_box_alloc
g_atomic_rc_box_alloc0
g_atomic_rc_box_new
g_atomic_rc_box_new0
g_atomic_rc_box_dup
g_atomic_rc_box_acquire
g_atomic_rc_box_release
g_atomic_rc_box_release_full
g_atomic_rc_box_get_size
</SECTION>
<SECTION>

View File

@ -95,8 +95,6 @@ endif
CLEANFILES ?=
CLEANFILES += $(man_MANS)
EXTRA_DIST += $(man_MANS)
dist-hook-local: all-local
gobject-docs-clean: clean

View File

@ -188,6 +188,14 @@
<title>Index of new symbols in 2.46</title>
<xi:include href="xml/api-index-2.46.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-2-54" role="2.54">
<title>Index of new symbols in 2.54</title>
<xi:include href="xml/api-index-2.54.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-2-56" role="2.56">
<title>Index of new symbols in 2.56</title>
<xi:include href="xml/api-index-2.56.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>

View File

@ -288,6 +288,9 @@ unix_sources = \
gportalsupport.h \
$(portal_sources) \
$(NULL)
nodist_unix_sources = \
$(nodist_portal_sources) \
$(NULL)
giounixincludedir=$(includedir)/gio-unix-2.0/gio
giounixinclude_HEADERS = \
@ -316,6 +319,8 @@ endif
gdbus_daemon_sources = \
gdbusdaemon.c \
gdbusdaemon.h \
$(NULL)
nodist_gdbus_daemon_sources = \
gdbus-daemon-generated.c \
gdbus-daemon-generated.h \
$(NULL)
@ -336,6 +341,9 @@ win32_actual_sources = \
gwin32networkmonitor.h \
gwin32notificationbackend.c \
$(NULL)
nodist_win32_actual_sources = \
$(nodist_gdbus_daemon_sources) \
$(NULL)
win32_more_sources_for_vcproj = \
gwin32appinfo.c \
@ -353,6 +361,7 @@ appinfo_sources += gwin32appinfo.c gwin32appinfo.h
contenttype_sources += gcontenttype-win32.c
platform_libadd += -lshlwapi -lws2_32 -ldnsapi -liphlpapi
win32_sources = $(win32_actual_sources)
nodist_win32_sources = $(nodist_win32_actual_sources)
giowin32includedir=$(includedir)/gio-win32-2.0/gio
giowin32include_HEADERS = \
@ -392,7 +401,9 @@ portal_sources = \
gnetworkmonitorportal.h \
gproxyresolverportal.c \
gproxyresolverportal.h \
$(xdp_dbus_built_sources) \
$(NULL)
nodist_portal_sources = \
$(xdp_dbus_built_sources) \
$(NULL)
if OS_UNIX
@ -546,14 +557,16 @@ gio_base_sources = \
gzlibcompressor.c \
gzlibdecompressor.c \
gmountprivate.h \
gioenumtypes.h \
gioenumtypes.c \
glistmodel.c \
gliststore.c \
$(application_sources) \
$(gdbus_sources) \
$(local_sources) \
$(NULL)
nodist_gio_base_sources = \
gioenumtypes.h \
gioenumtypes.c \
$(NULL)
libgio_2_0_la_SOURCES = \
$(gio_base_sources) \
@ -563,6 +576,11 @@ libgio_2_0_la_SOURCES = \
$(win32_sources) \
$(settings_sources) \
$(NULL)
nodist_libgio_2_0_la_SOURCES = \
$(nodist_gio_base_sources) \
$(nodist_unix_sources) \
$(nodist_win32_sources) \
$(NULL)
EXTRA_DIST += strinfo.c
@ -762,8 +780,11 @@ gio_headers = \
gioincludedir=$(includedir)/glib-2.0/gio/
gioinclude_HEADERS = \
$(gio_headers) \
gioenumtypes.h
$(gio_headers) \
$(NULL)
nodist_gioinclude_HEADERS = \
gioenumtypes.h \
$(NULL)
nodist_gioinclude_HEADERS = \
gnetworking.h \
@ -785,7 +806,6 @@ EXTRA_DIST += \
gioenumtypes.c.template \
gio.rc.in \
gschema.dtd \
gconstructor_as_data.h \
$(NULL)
BUILT_EXTRA_DIST += \
@ -846,11 +866,13 @@ gconstructor_as_data.h: $(top_srcdir)/glib/gconstructor.h data-to-c.py
glib_compile_schemas_LDADD = $(top_builddir)/glib/libglib-2.0.la
glib_compile_schemas_SOURCES = \
gconstructor_as_data.h \
gvdb/gvdb-format.h \
gvdb/gvdb-builder.h \
gvdb/gvdb-builder.c \
glib-compile-schemas.c
nodist_glib_compile_schemas_SOURCES = \
gconstructor_as_data.h \
$(NULL)
gsettings_LDADD = libgio-2.0.la \
$(top_builddir)/gobject/libgobject-2.0.la \

View File

@ -557,7 +557,8 @@ nodist_resources_SOURCES = test_resources.c test_resources2.c test_resources2.h
resources_DEPENDENCIES = test.gresource
test_ltlibraries += libresourceplugin.la
libresourceplugin_la_SOURCES = resourceplugin.c plugin_resources.c
libresourceplugin_la_SOURCES = resourceplugin.c
nodist_libresourceplugin_la_SOURCES = plugin_resources.c
libresourceplugin_la_LDFLAGS = -avoid-version -module -export-dynamic $(no_undefined)
libresourceplugin_la_LIBADD = $(LDADD)

View File

@ -1,6 +1,8 @@
## Process this file with automake to produce Makefile.in
include $(top_srcdir)/glib.mk
bin_PROGRAMS =
#
# Generate glibconfig.h
#
@ -366,8 +368,6 @@ libglib_2_0_la_LDFLAGS = $(GLIB_LINK_FLAGS) \
-version-info $(LT_CURRENT):$(LT_REVISION):$(LT_AGE) \
-export-dynamic $(no_undefined)
INSTALL_PROGS=
if ENABLE_DTRACE
glib_probes.h: glib_probes.d
$(AM_V_GEN) $(DTRACE) -C -h -s $< -o $@.tmp
@ -410,15 +410,26 @@ gspawn-win64-helper-console.c:
echo '#define HELPER_CONSOLE' >$@
echo '#include "gspawn-win32-helper.c"' >>$@
nodist_win_helper_sources = \
gspawn-win32-helper-console.c \
gspawn-win64-helper.c \
gspawn-win64-helper-console.c \
$(NULL)
BUILT_SOURCES += $(nodist_win_helper_sources)
CLEANFILES += $(nodist_win_helper_sources)
if OS_WIN32
if OS_WIN32_X64
INSTALL_PROGS += gspawn-win64-helper gspawn-win64-helper-console
bin_PROGRAMS += gspawn-win64-helper gspawn-win64-helper-console
nodist_gspawn_win64_helper_SOURCES = gspawn-win64-helper.c
nodist_gspawn_win64_helper_console_SOURCES = gspawn-win64-helper-console.c
gspawn_win64_helper_LDADD = libglib-2.0.la
gspawn_win64_helper_LDFLAGS = -mwindows
gspawn_win64_helper_console_LDADD = libglib-2.0.la
else
INSTALL_PROGS += gspawn-win32-helper gspawn-win32-helper-console
bin_PROGRAMS += gspawn-win32-helper gspawn-win32-helper-console
nodist_gspawn_win32_helper_console_SOURCES = gspawn-win32-helper-console.c
gspawn_win32_helper_LDADD = libglib-2.0.la
gspawn_win32_helper_LDFLAGS = -mwindows
gspawn_win32_helper_console_LDADD = libglib-2.0.la
@ -428,11 +439,9 @@ endif
glib-win32-res.o: glib.rc
$(WINDRES) glib.rc $@
bin_PROGRAMS = ${INSTALL_PROGS}
if OS_UNIX
INSTALL_PROGS += gtester
bin_PROGRAMS += gtester
gtester_SOURCES = gtester.c
gtester_LDADD = libglib-2.0.la

View File

@ -1774,7 +1774,7 @@ find_file_in_data_dirs (const gchar *file,
* This function looks for a desktop bookmark file named @file in the
* paths returned from g_get_user_data_dir() and g_get_system_data_dirs(),
* loads the file into @bookmark and returns the file's full path in
* @full_path. If the file could not be loaded then an %error is
* @full_path. If the file could not be loaded then @error is
* set to either a #GFileError or #GBookmarkFileError.
*
* Returns: %TRUE if a key file could be loaded, %FALSE otherwise

View File

@ -164,7 +164,7 @@ gchar *g_filename_to_uri (const gchar *filename,
GLIB_AVAILABLE_IN_ALL
gchar *g_filename_display_name (const gchar *filename) G_GNUC_MALLOC;
GLIB_AVAILABLE_IN_ALL
gboolean g_get_filename_charsets (const gchar ***charsets);
gboolean g_get_filename_charsets (const gchar ***filename_charsets);
GLIB_AVAILABLE_IN_ALL
gchar *g_filename_display_basename (const gchar *filename) G_GNUC_MALLOC;

View File

@ -2293,7 +2293,7 @@ g_option_group_free (GOptionGroup *group)
*
* Increments the reference count of @group by one.
*
* Returns: a #GoptionGroup
* Returns: a #GOptionGroup
*
* Since: 2.44
*/

View File

@ -314,12 +314,12 @@ get_default_item_id (void)
* If the source language of @str is known, it can used to improve the
* accuracy of the translation by passing it as @from_locale. It should
* be a valid POSIX locale string (of the form
* "language[_territory][.codeset][@modifier]").
* `language[_territory][.codeset][@modifier]`).
*
* If @from_locale is %NULL then the current locale is used.
*
* If you want to do translation for no specific locale, and you want it
* to be done independently of the currently locale, specify "C" for
* to be done independently of the currently locale, specify `"C"` for
* @from_locale.
*
* Returns: a string in plain ASCII

View File

@ -1364,10 +1364,10 @@ g_variant_new_object_path (const gchar *object_path)
* should ensure that a string is a valid D-Bus object path before
* passing it to g_variant_new_object_path().
*
* A valid object path starts with '/' followed by zero or more
* sequences of characters separated by '/' characters. Each sequence
* must contain only the characters "[A-Z][a-z][0-9]_". No sequence
* (including the one following the final '/' character) may be empty.
* A valid object path starts with `/` followed by zero or more
* sequences of characters separated by `/` characters. Each sequence
* must contain only the characters `[A-Z][a-z][0-9]_`. No sequence
* (including the one following the final `/` character) may be empty.
*
* Returns: %TRUE if @string is a D-Bus object path
*

View File

@ -498,7 +498,7 @@ g_object_do_class_init (GObjectClass *class)
* text_view)
* ]|
* It is important to note that you must use
* [canonical][canonical-parameter-name] parameter names as
* [canonical parameter names][canonical-parameter-names] as
* detail strings for the notify signal.
*/
gobject_signals[NOTIFY] =

View File

@ -40,7 +40,8 @@ AM_TESTS_ENVIRONMENT = \
MALLOC_CHECK_=2 \
MALLOC_PERTURB_=$$(($${RANDOM:-256} % 256))
accumulator_SOURCES = accumulator.c testmarshal.c testmarshal.h
accumulator_SOURCES = accumulator.c
nodist_accumulator_SOURCES = testmarshal.c testmarshal.h
signals_SOURCES = signals.c
defaultiface_SOURCES = defaultiface.c testmodule.c testmodule.h
dynamictype_SOURCES = dynamictype.c testmodule.c testmodule.h
@ -68,18 +69,6 @@ testmarshal.c: testmarshal.h testmarshal.list $(glib_genmarshal)
&& rm -f xgen-gmc xgen-gmc~
BUILT_SOURCES += testmarshal.h testmarshal.c
CLEANFILES += stamp-testmarshal.h
CLEANFILES += stamp-testmarshal.h testmarshal.h testmarshal.c
EXTRA_DIST += testcommon.h testmarshal.list
BUILT_EXTRA_DIST += testmarshal.h testmarshal.c
endif # !CROSS_COMPILING
dist-hook: $(BUILT_EXTRA_DIST)
files='$(BUILT_EXTRA_DIST)'; \
for f in $$files; do \
if test -f $$f; then d=.; else d=$(srcdir); fi; \
cp $$d/$$f $(distdir) || exit 1; done
distclean-local:
if test $(srcdir) = .; then :; else \
rm -f $(BUILT_EXTRA_DIST); \
fi
endif # !CROSS_COMPILING