From 53d607438c3824a6f1e540d06f5716148f6496a5 Mon Sep 17 00:00:00 2001 From: Thomas Jarosch Date: Thu, 17 Apr 2008 09:13:04 +0000 Subject: [PATCH] libt2n: (tomj) fixed out of tree builds. Added ChangeLog and AUTHORS. Updated README to match libftdi's style. --- AUTHORS | 8 ++ ChangeLog | 14 +++ Doxyfile | 275 ------------------------------------------------------- Makefile.am | 2 +- README | 30 ++++++- doc/Doxyfile.in | 8 +- doc/Makefile.am | 3 +- libt2n.spec.in | 4 +- 8 files changed, 57 insertions(+), 287 deletions(-) create mode 100644 AUTHORS create mode 100644 ChangeLog delete mode 100644 Doxyfile diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..dd5adfd --- /dev/null +++ b/AUTHORS @@ -0,0 +1,8 @@ +Main developers: + + Intra2net AG + +Contributors in alphabetical order, +see Changelog for full details: + + Nobody contributed yet :-) diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..b91212f --- /dev/null +++ b/ChangeLog @@ -0,0 +1,14 @@ +New in 0.4 +---------- +* Fix build of documentation for "out of tree" builds +* Fixed a bug with nested namespaces +* Updated documentation + +New in 0.3 +---------- +* Fixed a bug in the automatic code generator +* Updated autoconf suite + +New in 0.2 +------------ +* First public release diff --git a/Doxyfile b/Doxyfile deleted file mode 100644 index b09329e..0000000 --- a/Doxyfile +++ /dev/null @@ -1,275 +0,0 @@ -# Doxyfile 1.4.1-KDevelop - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -PROJECT_NAME = libt2n.kdevelop -PROJECT_NUMBER = 0.1 -OUTPUT_DIRECTORY = -CREATE_SUBDIRS = NO -OUTPUT_LANGUAGE = English -USE_WINDOWS_ENCODING = NO -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the -ALWAYS_DETAILED_SEC = NO -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = YES -STRIP_FROM_PATH = /mnt/gerd-intranator/arnied/ -STRIP_FROM_INC_PATH = -SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO -MULTILINE_CPP_IS_BRIEF = NO -DETAILS_AT_TOP = NO -INHERIT_DOCS = YES -DISTRIBUTE_GROUP_DOC = NO -TAB_SIZE = 8 -ALIASES = -OPTIMIZE_OUTPUT_FOR_C = NO -OPTIMIZE_OUTPUT_JAVA = NO -SUBGROUPING = YES -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = NO -EXTRACT_PRIVATE = NO -EXTRACT_STATIC = NO -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_LOCAL_METHODS = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = NO -CASE_SENSE_NAMES = YES -HIDE_SCOPE_NAMES = NO -SHOW_INCLUDE_FILES = YES -INLINE_INFO = YES -SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO -SORT_BY_SCOPE_NAME = NO -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -SHOW_DIRECTORIES = YES -FILE_VERSION_FILTER = -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = NO -WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = /mnt/gerd-intranator/libt2n -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.mm \ - *.dox \ - *.C \ - *.CC \ - *.C++ \ - *.II \ - *.I++ \ - *.H \ - *.HH \ - *.H++ \ - *.CS \ - *.PHP \ - *.PHP3 \ - *.M \ - *.MM \ - *.C \ - *.H \ - *.tlh \ - *.diff \ - *.patch \ - *.moc \ - *.xpm \ - *.dox -RECURSIVE = yes -EXCLUDE = -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = * -EXAMPLE_RECURSIVE = NO -IMAGE_PATH = -INPUT_FILTER = -FILTER_PATTERNS = -FILTER_SOURCE_FILES = NO -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = NO -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES -VERBATIM_HEADERS = YES -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- -GENERATE_HTML = YES -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_ALIGN_MEMBERS = YES -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = -GENERATE_CHI = NO -BINARY_TOC = NO -TOC_EXPAND = NO -DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = NO -TREEVIEW_WIDTH = 250 -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = YES -LATEX_OUTPUT = latex -LATEX_CMD_NAME = latex -MAKEINDEX_CMD_NAME = makeindex -COMPACT_LATEX = NO -PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = -PDF_HYPERLINKS = NO -USE_PDFLATEX = NO -LATEX_BATCHMODE = NO -LATEX_HIDE_INDICES = NO -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- -GENERATE_RTF = NO -RTF_OUTPUT = rtf -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- -GENERATE_MAN = NO -MAN_OUTPUT = man -MAN_EXTENSION = .3 -MAN_LINKS = NO -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- -GENERATE_XML = yes -XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = -XML_PROGRAMLISTING = YES -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- -GENERATE_AUTOGEN_DEF = NO -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- -GENERATE_PERLMOD = NO -PERLMOD_LATEX = NO -PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = YES -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = libt2n.tag -ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -PERL_PATH = /usr/bin/perl -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = NO -CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -GROUP_GRAPHS = YES -UML_LOOK = NO -TEMPLATE_RELATIONS = NO -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = NO -GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES -DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = -MAX_DOT_GRAPH_WIDTH = 1024 -MAX_DOT_GRAPH_HEIGHT = 1024 -MAX_DOT_GRAPH_DEPTH = 1000 -DOT_TRANSPARENT = NO -DOT_MULTI_TARGETS = NO -GENERATE_LEGEND = YES -DOT_CLEANUP = YES -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- -SEARCHENGINE = NO diff --git a/Makefile.am b/Makefile.am index 1bfebc6..efb7e0c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -17,4 +17,4 @@ endif m4datadir = $(datadir)/aclocal m4data_DATA = libt2n.m4 -EXTRA_DIST = COPYING COPYING.LIB $(m4data_DATA) test-build-install-use +EXTRA_DIST = AUTHORS ChangeLog COPYING COPYING.LIB $(m4data_DATA) test-build-install-use diff --git a/README b/README index 637c2fb..dec61cf 100644 --- a/README +++ b/README @@ -1,3 +1,29 @@ -libt2n (talk2neighbor) is a C++ IPC (inter process communication) library. +------------------------------------------------------------------- +libt2n version 0.3 +------------------------------------------------------------------- +libt2n (talk2neighbor) is a C++ IPC (inter process communication) library +with an additional code generator (libt2n-codegen). -The full documentation is generated by doxygen in the doc directory. +Before inventing our own IPC library, we checked a lot of other IPC frameworks +like CORBA, D-BUS and ICE. But they weren't easy to use and did not allow +passing complex C++ objects like vectors, maps and your own classes. + +Communication between client and server is currently done using +Unix domain sockets (named pipes) or TCP. But the library is designed +transport-independent, so it can be expanded to +shared memory or other mechanisms. + +Serializing all the complex objects is done with Boost serialization. +The complete manual is generated by doxygen in the doc directory. + +Changes +------- +* Fixed a bug in the automatic code generator +* Updated autoconf suite + +You'll find the newest version of libt2n at: +http://www.intra2net.com/de/produkte/opensource/libt2n/ + +------------------------------------------------------------------- +www.intra2net.com 2006-2008 Intra2net AG +------------------------------------------------------------------- diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 60bc3f7..1eb5131 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -459,9 +459,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -# todo: is it possible to use shell variables here? - -INPUT = . ../src ../codegen +INPUT = @top_srcdir@/doc @top_srcdir@/src @top_srcdir@/codegen # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -502,7 +500,7 @@ EXCLUDE_PATTERNS = # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = ../examples-codegen/example1/ ../examples-codegen/example1-client/ +EXAMPLE_PATH = @top_srcdir@/examples-codegen/example1/ @top_srcdir@/examples-codegen/example1-client/ # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -652,7 +650,7 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = header.html +HTML_HEADER = @top_srcdir@/doc/header.html # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a diff --git a/doc/Makefile.am b/doc/Makefile.am index c1297fe..2976ec3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,8 +8,7 @@ endif all: $(MANUALS) -# todo: separate build dir still doesn't work html/index.html: $(top_srcdir)/src/*.cpp $(top_srcdir)/src/*.hxx $(top_srcdir)/codegen/*.hxx $(top_srcdir)/codegen/*.cpp $(srcdir)/index.doc - if test -f header.html; then $(DOXYGEN); else echo "FIXME: doxygen documentation cannot be built using a seperate build directory"; fi + $(DOXYGEN) EXTRA_DIST = index.doc header.html diff --git a/libt2n.spec.in b/libt2n.spec.in index 183d75b..c8a81b2 100644 --- a/libt2n.spec.in +++ b/libt2n.spec.in @@ -46,11 +46,11 @@ rm -fr $RPM_BUILD_ROOT %files %defattr(-,root,root) -%doc COPYING.LIB COPYING +%doc AUTHORS README COPYING.LIB COPYING %{prefix}/lib/libt2n.so* %files devel -%doc doc examples examples-codegen +%doc ChangeLog doc examples examples-codegen %defattr(-,root,root) %{prefix}/bin/libt2n-codegen %{prefix}/lib/*.*a* -- 1.7.1