colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: create new master NM documentation module

Browse Source
This commit is contained in:
Dan Williams
2011-02-16 16:24:16 -06:00
parent c17721b360
commit a90a7f7dd2
9 changed files with 202 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
.gitignore vendored
View File

@@ -57,9 +57,23 @@ docs/libnm-util/libnm-util.prerequisites
docs/libnm-util/libnm-util.signals
docs/libnm-util/libnm-util.types
docs/generate-settings-spec
docs/settings-spec.html
docs/spec.html
docs/api/version.xml
docs/api/generate-settings-spec
docs/api/settings-spec.html
docs/api/spec.html
docs/api/*.stamp
docs/api/html/
docs/api/tmpl/
docs/api/xml/
docs/api/NetworkManager-*.txt
docs/api/NetworkManager-decl-list.txt.bak
docs/api/NetworkManager-decl.txt.bak
docs/api/NetworkManager.args
docs/api/NetworkManager.hierarchy
docs/api/NetworkManager.interfaces
docs/api/NetworkManager.prerequisites
docs/api/NetworkManager.signals
docs/api/NetworkManager.types
examples/C/add-connection-dbus-glib
examples/C/add-connection-libnm-glib

10
COPYING
View File

@@ -65,7 +65,7 @@ patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
@@ -120,7 +120,7 @@ above, provided that you also meet all of these conditions:
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
@@ -178,7 +178,7 @@ access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
@@ -235,7 +235,7 @@ impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
@@ -288,7 +288,7 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest

2
configure.ac
View File

@@ -611,6 +611,8 @@ po/Makefile.in
policy/Makefile
data/Makefile
docs/Makefile
docs/api/Makefile
docs/api/version.xml
docs/libnm-glib/Makefile
docs/libnm-util/Makefile
NetworkManager.pc

46
docs/Makefile.am
View File

@@ -1,50 +1,6 @@
if WITH_DOCS
SUBDIRS = libnm-glib libnm-util
INCLUDES = \
-I$(top_srcdir)/include \
-I$(top_srcdir)/libnm-util
noinst_PROGRAMS = \
generate-settings-spec
generate_settings_spec_SOURCES = \
generate-settings-spec.c
generate_settings_spec_CPPFLAGS = \
$(GLIB_CFLAGS) \
$(DBUS_CFLAGS)
generate_settings_spec_LDADD = \
$(top_builddir)/libnm-util/libnm-util.la \
$(GLIB_LIBS) \
$(DBUS_LIBS)
XSLTPROC = xsltproc --xinclude --nonet
XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.xml)
OTHER_FILES= \
$(top_srcdir)/introspection/all.xml \
$(top_srcdir)/introspection/generic-types.xml \
$(top_srcdir)/introspection/errors.xml \
$(top_srcdir)/introspection/vpn-errors.xml \
$(top_srcdir)/tools/doc-generator.xsl \
$(top_srcdir)/introspection/generic-types.xml
GENERATED_FILES = spec.html settings-spec.html
spec.html: $(XMLS) $(OTHER_FILES)
$(XSLTPROC) $(top_srcdir)/tools/doc-generator.xsl $(top_srcdir)/introspection/all.xml > $@
settings-spec.html: generate-settings-spec $(top_builddir)/libnm-util/libnm-util.la
$(builddir)/generate-settings-spec $(builddir)/settings-spec.html
all: $(GENERATED_FILES)
EXTRA_DIST = $(GENERATED_FILES)
CLEANFILES = $(GENERATED_FILES)
SUBDIRS = api libnm-glib libnm-util
endif

82
docs/api/Makefile.am Normal file
View File

@@ -0,0 +1,82 @@
GENERATE_SETTINGS_SPEC_SOURCE = generate-settings-spec.c
AUTOMAKE_OPTIONS = 1.7
if WITH_DOCS
INCLUDES = \
-I$(top_srcdir)/include \
-I$(top_srcdir)/libnm-util
noinst_PROGRAMS = \
generate-settings-spec
generate_settings_spec_SOURCES = \
$(GENERATE_SETTINGS_SPEC_SOURCE)
generate_settings_spec_CPPFLAGS = \
$(GLIB_CFLAGS) \
$(DBUS_CFLAGS)
generate_settings_spec_LDADD = \
$(top_builddir)/libnm-util/libnm-util.la \
$(GLIB_LIBS) \
$(DBUS_LIBS)
XSLTPROC = xsltproc --xinclude --nonet
XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.xml)
OTHER_FILES= \
$(top_srcdir)/introspection/all.xml \
$(top_srcdir)/introspection/generic-types.xml \
$(top_srcdir)/introspection/errors.xml \
$(top_srcdir)/introspection/vpn-errors.xml \
$(top_srcdir)/tools/doc-generator.xsl \
$(top_srcdir)/introspection/generic-types.xml
GENERATED_FILES = spec.html settings-spec.html
spec.html: $(XMLS) $(OTHER_FILES)
$(XSLTPROC) $(top_srcdir)/tools/doc-generator.xsl $(top_srcdir)/introspection/all.xml > $@
cp $(builddir)/$@ $(builddir)/html/
settings-spec.html: generate-settings-spec $(top_builddir)/libnm-util/libnm-util.la
$(builddir)/generate-settings-spec $(builddir)/$@
cp $(builddir)/$@ $(builddir)/html/
all: $(GENERATED_FILES)
####################################
# The name of the module.
DOC_MODULE=NetworkManager
# The top-level SGML file.
DOC_MAIN_SGML_FILE=network-manager-docs.xml
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-mktmpl
MKTMPL_OPTIONS=
# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
content_files = \
version.xml \
$(NULL)
include $(top_srcdir)/gtk-doc.make
####################################
EXTRA_DIST += $(GENERATED_FILES)
CLEANFILES += $(GENERATED_FILES)
else
EXTRA_DIST = $(GENERATE_SETTINGS_SPEC_SOURCE)
endif
EXTRA_DIST += version.xml.in

0
docs/generate-settings-spec.c → docs/api/generate-settings-spec.c
View File

94
docs/api/network-manager-docs.xml Normal file
View File

@@ -0,0 +1,94 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>NetworkManager D-Bus Reference Manual</title>
<releaseinfo>Version &version;</releaseinfo>
<authorgroup>
<author>
<firstname>Dan</firstname>
<surname>Williams</surname>
<affiliation>
<address>
<email>dcbw@redhat.com</email>
</address>
</affiliation>
</author>
</authorgroup>
<copyright>
<year>2011</year>
<holder>The NetworkManager Authors</holder>
</copyright>
<legalnotice>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the <citetitle>GNU Free
Documentation License</citetitle>, Version 1.1 or any later
version published by the Free Software Foundation with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
Foundation by visiting <ulink type="http"
url="http://www.fsf.org">their Web site</ulink> or by writing
to:
<address>
The Free Software Foundation, Inc.,
<street>59 Temple Place</street> - Suite 330,
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
<country>USA</country>
</address>
</para>
<para>
Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and those trademarks
are made aware to the members of the GNOME Documentation
Project, the names have been printed in caps or initial caps.
</para>
</legalnotice>
</bookinfo>
<reference id="ref-dbus">
<title>D-Bus API Reference</title>
<partintro>
<para>
This part documents the D-Bus interface used to access the
NetworkManager daemon.
</para>
</partintro>
<ulink url="spec.html"/>
</reference>
<reference id="ref-settings">
<title>Network Configuration Setting Specification</title>
<partintro>
<para>
This part documents the properties and value types of each "Setting"
object that composes the basic unit of NetworkManager configuration,
the "Connection".
</para>
</partintro>
<ulink url="settings-spec.html"/>
</reference>
<index>
<title>Index</title>
</index>
<!-- License -->
<appendix id="license">
<title>License</title>
<para>
<programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
</para>
</appendix>
</book>

0
docs/api/network-manager-overrides.txt Normal file
View File

1
docs/api/version.xml.in Normal file
View File

@@ -0,0 +1 @@
@VERSION@