[gspell] docs: document pkg-config name in the intro
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gspell] docs: document pkg-config name in the intro
- Date: Mon, 8 Aug 2016 13:37:40 +0000 (UTC)
commit bcab9c41d8bd597d3fe006f9055f5da07d60aab5
Author: Sébastien Wilmet <swilmet gnome org>
Date: Mon Aug 8 15:22:10 2016 +0200
docs: document pkg-config name in the intro
And do not hardcode the gspell API version.
configure.ac | 1 +
docs/reference/Makefile.am | 9 +++++++--
docs/reference/{intro.xml => intro.xml.in} | 14 ++++++++++++++
3 files changed, 22 insertions(+), 2 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 2114209..395b37f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -210,6 +210,7 @@ AC_CONFIG_FILES([
Makefile
docs/Makefile
docs/reference/gspell-docs.xml
+ docs/reference/intro.xml
docs/reference/Makefile
gspell/Makefile
gspell/resources/Makefile
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index e62e6a2..33b30b1 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -64,7 +64,12 @@ MAINTAINERCLEANFILES = \
# include common portion ...
include $(top_srcdir)/gtk-doc.make
-EXTRA_DIST += gspell-docs.xml.in
-DISTCLEANFILES = gspell-docs.xml
+EXTRA_DIST += \
+ gspell-docs.xml.in \
+ intro.xml.in
+
+DISTCLEANFILES = \
+ gspell-docs.xml \
+ intro.xml
-include $(top_srcdir)/git.mk
diff --git a/docs/reference/intro.xml b/docs/reference/intro.xml.in
similarity index 69%
rename from docs/reference/intro.xml
rename to docs/reference/intro.xml.in
index 15ae36a..196c369 100644
--- a/docs/reference/intro.xml
+++ b/docs/reference/intro.xml.in
@@ -16,6 +16,20 @@
</para>
<refsect1>
+ <title>pkg-config name</title>
+ <para>
+ The pkg-config name of the gspell library is: <code>gspell-@GSPELL_API_VERSION@</code>
+ </para>
+ <para>
+ To compile a program that uses gspell, you can for example use the
+ following command:
+ </para>
+ <para>
+ <code>$ gcc hello.c `pkg-config --cflags --libs gspell-@GSPELL_API_VERSION@` -o hello</code>
+ </para>
+ </refsect1>
+
+ <refsect1>
<title>How to enable inline spell checking in a GtkTextView</title>
<para>
See the <link
linkend="gspell-text-view-basic-setup"><function>gspell_text_view_basic_setup()</function></link>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]