From a90a7f7dd26fb49721107f74651e8bfea47a98ad Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Wed, 16 Feb 2011 16:24:16 -0600 Subject: [PATCH] docs: create new master NM documentation module --- .gitignore | 20 +++++- COPYING | 10 +-- configure.ac | 2 + docs/Makefile.am | 46 +----------- docs/api/Makefile.am | 82 +++++++++++++++++++++ docs/{ => api}/generate-settings-spec.c | 0 docs/api/network-manager-docs.xml | 94 +++++++++++++++++++++++++ docs/api/network-manager-overrides.txt | 0 docs/api/version.xml.in | 1 + 9 files changed, 202 insertions(+), 53 deletions(-) create mode 100644 docs/api/Makefile.am rename docs/{ => api}/generate-settings-spec.c (100%) create mode 100644 docs/api/network-manager-docs.xml create mode 100644 docs/api/network-manager-overrides.txt create mode 100644 docs/api/version.xml.in diff --git a/.gitignore b/.gitignore index 21134de34b..be24050c0f 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/COPYING b/COPYING index fde38aaa20..d14074f524 100644 --- a/COPYING +++ b/COPYING @@ -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 diff --git a/configure.ac b/configure.ac index 6cb9414d48..0266c6a4f4 100644 --- a/configure.ac +++ b/configure.ac @@ -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 diff --git a/docs/Makefile.am b/docs/Makefile.am index 5a3da7e067..a1d1b9b378 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -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 diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am new file mode 100644 index 0000000000..7196f2250f --- /dev/null +++ b/docs/api/Makefile.am @@ -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 + diff --git a/docs/generate-settings-spec.c b/docs/api/generate-settings-spec.c similarity index 100% rename from docs/generate-settings-spec.c rename to docs/api/generate-settings-spec.c diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml new file mode 100644 index 0000000000..92618f01fa --- /dev/null +++ b/docs/api/network-manager-docs.xml @@ -0,0 +1,94 @@ + + +]> + + + NetworkManager D-Bus Reference Manual + Version &version; + + + Dan + Williams + +
+ dcbw@redhat.com +
+ + + + + + 2011 + The NetworkManager Authors + + + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free + Documentation License, 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 GNU Free + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: + +
+ The Free Software Foundation, Inc., + 59 Temple Place - Suite 330, + Boston, MA 02111-1307, + USA +
+ + + + 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. + + + + + + D-Bus API Reference + + + This part documents the D-Bus interface used to access the + NetworkManager daemon. + + + + + + + Network Configuration Setting Specification + + + This part documents the properties and value types of each "Setting" + object that composes the basic unit of NetworkManager configuration, + the "Connection". + + + + + + + Index + + + + + + License + +FIXME: MISSING XINCLUDE CONTENT + + + + diff --git a/docs/api/network-manager-overrides.txt b/docs/api/network-manager-overrides.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/api/version.xml.in b/docs/api/version.xml.in new file mode 100644 index 0000000000..d78bda9342 --- /dev/null +++ b/docs/api/version.xml.in @@ -0,0 +1 @@ +@VERSION@