Skip to content

Commit

Permalink
Prepare for buildbot.
Browse files Browse the repository at this point in the history
  • Loading branch information
fpoirotte committed May 1, 2012
1 parent 6911545 commit 688b3b9
Show file tree
Hide file tree
Showing 11 changed files with 132 additions and 261 deletions.
16 changes: 13 additions & 3 deletions .gitignore
@@ -1,3 +1,13 @@
*.phar
*.tgz
docs/html/
/package.xml
/package_compatible.xml

/docs/html
/docs/api
/docs/enduser
/docs/coverage
/*.pem
/*.phar
/*.pubkey
/*.tgz
/*.tagfile.xml

3 changes: 3 additions & 0 deletions .gitmodules
@@ -0,0 +1,3 @@
[submodule "buildenv"]
path = buildenv
url = git://github.com/Erebot/Erebot_Buildenv.git
224 changes: 1 addition & 223 deletions Doxyfile
@@ -1,224 +1,2 @@
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "XML-RPC Library (XRL)"
PROJECT_BRIEF = "A simple XML-RPC client and server written in PHP."
OUTPUT_DIRECTORY = docs/
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English

BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4

ALIASES = "TODO=\todo"
ALIASES += "XXX=\todo"
ALIASES += "u{1}=\htmlonly <u>\1</u> \endhtmlonly\latexonly\underline{\1}\endlatexonly"
ALIASES += "i{1}=\htmlonly <em>\1</em> \endhtmlonly\latexonly\textit{\1}\endlatexonly"
ALIASES += "b{1}=\htmlonly <strong>\1</strong> \endhtmlonly\latexonly\textbf{\1}\endlatexonly"
ALIASES += "FIXME=\xrefitem FIXME \"Known issues\" \"Known Issues\""
ALIASES += "HACK=\xrefitem HACK \"Dirty hacks\" \"Dirty Hacks\""
ALIASES += "format{1}=\par Format\n<tt>\1</tt>\n"
ALIASES += "SuppressWarnings="

OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO

EXTENSION_MAPPING =
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
TYPEDEF_HIDES_STRUCT = NO
SYMBOL_CACHE_SIZE = 0

EXTRACT_ALL = NO
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = YES

HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = YES

INTERNAL_DOCS = YES
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES

SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = YES
SORT_GROUP_NAMES = YES
SORT_BY_SCOPE_NAME = NO

GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES

SEARCHENGINE = NO
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 29

SHOW_USED_FILES = YES
SHOW_DIRECTORIES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = YES

QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =

INPUT = src/ scripts/
INPUT_ENCODING = UTF-8
INPUT_FILTER =
FILE_PATTERNS = *.php
RECURSIVE = YES
LAYOUT_FILE =

FILE_VERSION_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO

EXCLUDE_SYMLINKS = YES
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =

@INCLUDE = buildenv/Doxyfile
EXAMPLE_PATH = example/
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = YES
IMAGE_PATH =

SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES

REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES

USE_HTAGS = NO
VERBATIM_HEADERS = YES
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 3

IGNORE_PREFIX = $ \
XRL_

GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
HTML_DYNAMIC_SECTIONS = YES

TOC_EXPAND = YES
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4

GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250

FORMULA_FONTSIZE = 10

GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = YES
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = YES
LATEX_HIDE_INDICES = YES

GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES

GENERATE_DOCSET = NO
GENERATE_HTMLHELP = NO
GENERATE_CHI = NO
GENERATE_QHP = NO
GENERATE_RTF = NO
GENERATE_AUTOGEN_DEF = NO
GENERATE_MAN = NO
GENERATE_PERLMOD = NO

ENABLE_PREPROCESSING = NO
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO

SEARCH_INCLUDES = NO
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES

TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = YES
EXTERNAL_GROUPS = YES

UML_LOOK = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
TEMPLATE_RELATIONS = NO
GENERATE_LEGEND = YES

HAVE_DOT = YES
DOT_FONTNAME = FreeSans
DOT_FONTSIZE = 10
DOT_FONTPATH =
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOT_GRAPH_MAX_NODES = 20
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
DOT_CLEANUP = YES
# Because the server is quite
# limited resource wise.
DOT_NUM_THREADS = 4
DOTFILE_DIRS =
MAX_DOT_GRAPH_DEPTH = 5

CLASS_DIAGRAMS = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
GROUP_GRAPHS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES

3 changes: 0 additions & 3 deletions README

This file was deleted.

1 change: 1 addition & 0 deletions README
4 changes: 4 additions & 0 deletions README.rst
@@ -0,0 +1,4 @@
A simple XML-RPC client and server written in PHP
=================================================


36 changes: 36 additions & 0 deletions build.xml
@@ -0,0 +1,36 @@
<?xml version="1.0"?>
<project name="XRL" description="" default="all">
<property name="qa.coverage.force" value="false"/>

<!--
Override subfile for PHPUnit as
XRL does not use a bootstrap file.
-->
<property name="subfile.phpunit" value="phing/phpunit.xml"/>

<fileset dir="src/" id="sources">
<include name="**/*.php"/>
</fileset>

<fileset dir="tests/" id="tests">
<include name="**/*.php"/>
</fileset>

<target name="all"/>

<!--
The buildenv sets the copyright line to "Erebot".
We override the target to fix that.
-->
<target name="doc_enduser" description="Generate end-user documentation in HTML format">
<property name="doc_release" value=""/>
<tstamp prefix="sphinx">
<format property="year" pattern="%Y" locale="C"/>
</tstamp>
<exec command="SPHINX_VERSION=${version} SPHINX_RELEASE=${version}${doc_release} SPHINX_PROJECT=${phing.project.name} sphinx-build -c buildenv/sphinx/ -b html -D html_use_opensearch=http://erebot.github.com/${phing.project.name} -D copyright='${sphinx.year}, The XRL Team' -d docs/enduser/doctrees docs/src docs/enduser/html"
passthru="true" checkreturn="true" logoutput="true"/>
</target>

<import file="buildenv/build.xml"/>
</project>

1 change: 1 addition & 0 deletions buildenv
Submodule buildenv added at 3f52f7
27 changes: 27 additions & 0 deletions docs/src/index.rst
@@ -0,0 +1,27 @@
Welcome to XRL's documentation!
===============================

XRL (short for XML-RPC Library) is a collection of PHP classes aiming at easing
the creation of XML-RPC clients or servers.
The API is meant to be very intuitive and yet very extensible in case you ever
need to customize parts of the code.

You can find more information about this project on the following websites:

* https://github.com/fpoirotte/xrl/ |---| Project page on GitHub.
* https://pear.erebot.net/ |---| PEAR channel for the project.
* https://buildbot.erebot.net/ |---| Our Continuous Integration server.
* http://travis-ci.org/#!/fpoirotte/xrl |---| Travis Continuous Integration.


Current status on http://travis-ci.org/:

.. image:: https://secure.travis-ci.org/fpoirotte/xrl.png
:alt: unknown
:target: http://travis-ci.org/#!/fpoirotte/xrl


.. |---| unicode:: U+02014 .. em dash
:trim:

.. vim: ts=4 et
7 changes: 7 additions & 0 deletions phing/phpunit.xml
@@ -0,0 +1,7 @@
<?xml version="1.0"?>
<project name="Erebot_buildenv_phpunit">
<phpunit codecoverage="true">
<formatter type="plain" usefile="false"/>
<batchtest><fileset refid="tests"/></batchtest>
</phpunit>
</project>

0 comments on commit 688b3b9

Please sign in to comment.