aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/coderDocs
diff options
context:
space:
mode:
Diffstat (limited to 'coderDocs')
-rw-r--r--coderDocs/BUILDING.md46
-rw-r--r--coderDocs/README14
-rw-r--r--coderDocs/TESTING.txt74
-rw-r--r--coderDocs/TODO.txt70
-rw-r--r--coderDocs/doxygen.conf290
5 files changed, 494 insertions, 0 deletions
diff --git a/coderDocs/BUILDING.md b/coderDocs/BUILDING.md
new file mode 100644
index 0000000..233fa08
--- /dev/null
+++ b/coderDocs/BUILDING.md
@@ -0,0 +1,46 @@
1# Building on Windows
2
3Steps:
4 * runprebuild.bat
5 * Load OpenSim.sln into Visual Studio .NET and build the solution.
6 * chdir bin
7 * copy OpenSim.ini.example to OpenSim.ini and other appropriate files in ../../config/config-include
8 * run OpenSim.exe
9
10# Building on Linux
11
12Prereqs:
13* Mono >= 2.4.3
14* Nant >= 0.85
15* On some Linux distributions you may need to install additional packages.
16 See http://opensimulator.org/wiki/Dependencies for more information.
17* May also use xbuild (included in mono distributions)
18* May use Monodevelop, a cross-platform IDE
19
20From the distribution type:
21 * ./runprebuild.sh
22 * nant (or !* xbuild)
23 * cd bin
24 * copy OpenSim.ini.example to OpenSim.ini and other appropriate files in ../../config/config-include
25 * run mono OpenSim.exe
26 !* xbuild option switches
27 !* clean: xbuild /target:clean
28 !* debug: (default) xbuild /property:Configuration=Debug
29 !* release: xbuild /property:Configuration=Release
30
31# Using Monodevelop
32
33From the distribution type:
34 * ./runprebuild.sh
35 * type monodevelop OpenSim.sln
36
37# References
38
39Helpful resources:
40* http://opensimulator.org/wiki/Build_Instructions
41
42
43# For Devuan ASCII (and likely Debian Stretch)
44
45 * xbuild /p:TargetFrameworkVersion="v4.5"
46
diff --git a/coderDocs/README b/coderDocs/README
new file mode 100644
index 0000000..6e94d1e
--- /dev/null
+++ b/coderDocs/README
@@ -0,0 +1,14 @@
1README
2
3This directory does not currently contain any OpenSimulator user level
4documentation. Such documentation can be found at http://opensimulator.org
5instead.
6
7Rather, this directory can contain source-code documentation as generated
8via the doxygen package, and some other coder level documentation.
9
10To do this, execute -
11
12doxygen doxygen.conf
13
14on the command line.
diff --git a/coderDocs/TESTING.txt b/coderDocs/TESTING.txt
new file mode 100644
index 0000000..da9dd60
--- /dev/null
+++ b/coderDocs/TESTING.txt
@@ -0,0 +1,74 @@
1= The Quick Guide to OpenSim Unit Testing =
2
3== Running Tests ==
4
5On Linux you will need to have NUnit installed (http://www.nunit.org).
6This is commonly available in distribution package repositories.
7
8When this is installed, run the command
9
10 > nant test
11
12Please see the TESTING ON WINDOWS section below for Windows instructions.
13
14== Adding Tests ==
15
16Tests should not be added to production assemblies. They should
17instead be added to assemblies of the name
18My.Production.Assembly.Tests.dll. This lets them easily be removed
19from production environments that don't want the bloat.
20
21Tests should be as close to the code as possible. It is recommended
22that if you are writing tests they end up in a "Tests" sub-directory
23of the directory where the code you are testing resides.
24
25If you have added a new test assembly that hasn't existed before you
26must list it in both ".nant/local.include"
27for it to be accessible to Linux users and to the continuous
28integration system.
29
30== TESTING ON WINDOWS ==
31
32To use nunit testing on opensim code, you have a variety of methods. The
33easiast methods involve using IDE capabilities to test code. Using
34VS2005/2008 I recommend using the testing capabilities of Resharper(commercial)
35or TestDriven.Net(free). Both will recognize nunit tests within your
36application and allow you to test them individually, or all at once, etc. You
37will also be able to step into debug mode into a test through these add-ins
38enabling a developer to jump right in and see how a specific
39test-case/scenerio works.
40
41Additionally, it is my understanding that sharpdevelop and monodevelop have
42their own nunit testing plugins within their IDE. Though I am not certain of
43their exact feature set or stability.
44
45== Using NUnit Directly ==
46The NUnit project is a very mature testing application. It can be obtained
47from www.nunit.org are via various package distrobutions for Linux. Please be
48sure to get a .Net 2.0 version of Nunit, as OpenSim makes use of .Net 2.0
49functionality.
50
51Nunit comes with 2 tools that will enable you to run tests from assembly
52inputs. Nunit-gui and nunit-console. NUnit-gui is a console that will let
53you view the execution of various tests within your assemblies and give visual
54indication of teir success or failure. This is a useful tool for those who
55lack IDE addins ( or lack IDEs at all ).
56
57Nunit console allows you to execute the nunit tests of assemblies via console.
58Its output will show test failures and successes and a summary of what
59happened. This is very useful for a quick overview and/or automated testing.
60
61=== Windows ===
62Windows version of nunit-console is by default .Net 2.0 if you downloaded the
63.Net 2.0 version of Nunit. Be sure to setup your PATH environment variable.
64
65=== Linux & OSX ===
66On these operating systems you will have to use the command "nunit-console2"
67
68=== Example ===
69
70nunit-console2 OpenSim.Framework.Tests.dll (on linux)
71nunit-console OpenSim.Framework.Tests.dll (on windows)
72
73See the file OpenSim/Data/Tests/Resources/TestDataConnections.ini
74for information to setup testing for data
diff --git a/coderDocs/TODO.txt b/coderDocs/TODO.txt
new file mode 100644
index 0000000..e3288d5
--- /dev/null
+++ b/coderDocs/TODO.txt
@@ -0,0 +1,70 @@
1TODO on release
2---------------
3Update version numbers.
4git log 8f280962f019d46e0367b29246283a1e34ceb955.. --pretty=format:"%s%n%b%n----------------" > NEWS.new
5 That'll be up to and excluding that revision.
6Clean that up, merge it into NEWS.
7Tag and release.
8
9
10Still to do -
11-------------
12
13Clean up the configs.
14 Why do we have Include-Common, Include-modules, Include-osslEnable, Include-Architecture, Include-Storage, Include-*Cache ??????
15 It only looks for "Include-".
16 Maybe move bin/assets and bin/inventory out of tree as well?
17
18save iar password check.
19 Check against the users password, and all the gods passwords.
20
21osForceSit() add a popup asking permission.
22 And with the os*animation, ossetspeed, ...
23
24
25 There was a showstopper, forgot what it is. lol
26
27
28
29Paths -
30-------
31
32cd /opt/opensim-0.9.0.1_MG/current/bin
33mono Robust.exe -inidirectory=/opt/opensim-0.9.0.1_MG/config/ROBUST
34mono OpenSim.exe -inidirectory=/opt/opensim-0.9.0.1_MG/config/sim05
35
36/usr/bin/mono /opt/opensim/current/bin/Robust.exe -logconfig=/opt/opensim/config/ROBUST/Robust.exe.config -inifile=/opt/opensim/config/ROBUST/Robust.ini
37
38
39 # When each .ini file is read, it's includes get added to the end of the list of .ini files to read
40 # -inimaster is read first, the defaults
41 # -inifile is read next, defaults to OpenSim.ini
42 # -inidirectory files are read next, in some random order
43 # include files are read last
44 # This is the problem, coz files included from earlier get to overide later files.
45 # Which is really against all that is holy.
46
47/usr/bin/mono /opt/opensim/current/bin/OpenSim.exe -logconfig=/opt/opensim/config/sim07/OpenSim.exe.config -inifile=/opt/opensim/config/OpenSim.ini -inidirectory=/opt/opensim/config/sim07
48
49
50
51Old TODO
52--------
53
54FIX BUGS -
55
56Zarro boogs!
57
58
59NEW FEATURES -
60
61In [Startup] there is this -
62 ; To run a script every few minutes, set the script filename here
63 ; timer_Script = "filename"
64Could do things with that perhaps.
65
66
67In [Startup] there is this -
68 ; Simulator Stats URI
69 ; Enable JSON simulator data by setting a URI name (case sensitive)
70 ; Stats_URI = "jsonSimStats"
diff --git a/coderDocs/doxygen.conf b/coderDocs/doxygen.conf
new file mode 100644
index 0000000..148de9c
--- /dev/null
+++ b/coderDocs/doxygen.conf
@@ -0,0 +1,290 @@
1# Doxyfile 1.8.2
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8
7PROJECT_NAME = OpenSim
8PROJECT_NUMBER = GIT
9PROJECT_BRIEF =
10PROJECT_LOGO =
11OUTPUT_DIRECTORY =
12CREATE_SUBDIRS = NO
13OUTPUT_LANGUAGE = English
14BRIEF_MEMBER_DESC = YES
15REPEAT_BRIEF = YES
16ABBREVIATE_BRIEF =
17ALWAYS_DETAILED_SEC = NO
18INLINE_INHERITED_MEMB = NO
19FULL_PATH_NAMES = YES
20STRIP_FROM_PATH =
21STRIP_FROM_INC_PATH =
22SHORT_NAMES = NO
23JAVADOC_AUTOBRIEF = NO
24QT_AUTOBRIEF = NO
25MULTILINE_CPP_IS_BRIEF = NO
26INHERIT_DOCS = YES
27SEPARATE_MEMBER_PAGES = NO
28TAB_SIZE = 8
29ALIASES =
30TCL_SUBST =
31OPTIMIZE_OUTPUT_FOR_C = NO
32OPTIMIZE_OUTPUT_JAVA = NO
33OPTIMIZE_FOR_FORTRAN = NO
34OPTIMIZE_OUTPUT_VHDL = NO
35EXTENSION_MAPPING =
36MARKDOWN_SUPPORT = YES
37AUTOLINK_SUPPORT = YES
38BUILTIN_STL_SUPPORT = NO
39CPP_CLI_SUPPORT = NO
40SIP_SUPPORT = NO
41IDL_PROPERTY_SUPPORT = YES
42DISTRIBUTE_GROUP_DOC = NO
43SUBGROUPING = YES
44INLINE_GROUPED_CLASSES = NO
45INLINE_SIMPLE_STRUCTS = NO
46TYPEDEF_HIDES_STRUCT = NO
47SYMBOL_CACHE_SIZE = 0
48LOOKUP_CACHE_SIZE = 0
49#---------------------------------------------------------------------------
50# Build related configuration options
51#---------------------------------------------------------------------------
52EXTRACT_ALL = YES
53EXTRACT_PRIVATE = NO
54EXTRACT_PACKAGE = NO
55EXTRACT_STATIC = NO
56EXTRACT_LOCAL_CLASSES = YES
57EXTRACT_LOCAL_METHODS = NO
58EXTRACT_ANON_NSPACES = NO
59HIDE_UNDOC_MEMBERS = NO
60HIDE_UNDOC_CLASSES = NO
61HIDE_FRIEND_COMPOUNDS = NO
62HIDE_IN_BODY_DOCS = NO
63INTERNAL_DOCS = NO
64CASE_SENSE_NAMES = YES
65HIDE_SCOPE_NAMES = NO
66SHOW_INCLUDE_FILES = YES
67FORCE_LOCAL_INCLUDES = NO
68INLINE_INFO = YES
69SORT_MEMBER_DOCS = YES
70SORT_BRIEF_DOCS = NO
71SORT_MEMBERS_CTORS_1ST = NO
72SORT_GROUP_NAMES = NO
73SORT_BY_SCOPE_NAME = NO
74STRICT_PROTO_MATCHING = NO
75GENERATE_TODOLIST = YES
76GENERATE_TESTLIST = YES
77GENERATE_BUGLIST = YES
78GENERATE_DEPRECATEDLIST= YES
79ENABLED_SECTIONS =
80MAX_INITIALIZER_LINES = 30
81SHOW_USED_FILES = YES
82SHOW_FILES = YES
83SHOW_NAMESPACES = YES
84FILE_VERSION_FILTER =
85LAYOUT_FILE =
86CITE_BIB_FILES =
87#---------------------------------------------------------------------------
88# configuration options related to warning and progress messages
89#---------------------------------------------------------------------------
90QUIET = NO
91WARNINGS = YES
92WARN_IF_UNDOCUMENTED = YES
93WARN_IF_DOC_ERROR = YES
94WARN_NO_PARAMDOC = NO
95WARN_FORMAT = "$file:$line: $text"
96WARN_LOGFILE = doxygen.error.log
97#---------------------------------------------------------------------------
98# configuration options related to the input files
99#---------------------------------------------------------------------------
100INPUT = ../OpenSim
101INPUT_ENCODING = UTF-8
102FILE_PATTERNS =
103RECURSIVE = YES
104EXCLUDE =
105EXCLUDE_SYMLINKS = NO
106EXCLUDE_PATTERNS =
107EXCLUDE_SYMBOLS =
108EXAMPLE_PATH =
109EXAMPLE_PATTERNS =
110EXAMPLE_RECURSIVE = NO
111IMAGE_PATH =
112INPUT_FILTER =
113FILTER_PATTERNS =
114FILTER_SOURCE_FILES = NO
115FILTER_SOURCE_PATTERNS =
116#---------------------------------------------------------------------------
117# configuration options related to source browsing
118#---------------------------------------------------------------------------
119SOURCE_BROWSER = NO
120INLINE_SOURCES = NO
121STRIP_CODE_COMMENTS = YES
122REFERENCED_BY_RELATION = NO
123REFERENCES_RELATION = NO
124REFERENCES_LINK_SOURCE = YES
125USE_HTAGS = NO
126VERBATIM_HEADERS = YES
127#---------------------------------------------------------------------------
128# configuration options related to the alphabetical class index
129#---------------------------------------------------------------------------
130ALPHABETICAL_INDEX = NO
131COLS_IN_ALPHA_INDEX = 5
132IGNORE_PREFIX =
133#---------------------------------------------------------------------------
134# configuration options related to the HTML output
135#---------------------------------------------------------------------------
136GENERATE_HTML = YES
137HTML_OUTPUT = html
138HTML_FILE_EXTENSION = .html
139HTML_HEADER =
140HTML_FOOTER =
141HTML_STYLESHEET =
142HTML_EXTRA_STYLESHEET =
143HTML_EXTRA_FILES =
144HTML_COLORSTYLE_HUE = 220
145HTML_COLORSTYLE_SAT = 100
146HTML_COLORSTYLE_GAMMA = 80
147HTML_TIMESTAMP = YES
148HTML_DYNAMIC_SECTIONS = NO
149HTML_INDEX_NUM_ENTRIES = 100
150GENERATE_DOCSET = NO
151DOCSET_FEEDNAME = "OpenSimulator docs"
152DOCSET_BUNDLE_ID = org.opensimulator.OpenSim
153DOCSET_PUBLISHER_ID = org.opensimulator.OpenSim
154DOCSET_PUBLISHER_NAME = OpenSim
155GENERATE_HTMLHELP = NO
156CHM_FILE =
157HHC_LOCATION =
158GENERATE_CHI = NO
159CHM_INDEX_ENCODING =
160BINARY_TOC = NO
161TOC_EXPAND = NO
162GENERATE_QHP = NO
163QCH_FILE =
164QHP_NAMESPACE = org.opensimulator.OpenSim
165QHP_VIRTUAL_FOLDER = doc
166QHP_CUST_FILTER_NAME =
167QHP_CUST_FILTER_ATTRS =
168QHP_SECT_FILTER_ATTRS =
169QHG_LOCATION =
170GENERATE_ECLIPSEHELP = NO
171ECLIPSE_DOC_ID = org.opensimulator.OpenSim
172DISABLE_INDEX = NO
173GENERATE_TREEVIEW = NO
174ENUM_VALUES_PER_LINE = 4
175TREEVIEW_WIDTH = 250
176EXT_LINKS_IN_WINDOW = NO
177FORMULA_FONTSIZE = 10
178FORMULA_TRANSPARENT = YES
179USE_MATHJAX = NO
180MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
181MATHJAX_EXTENSIONS =
182SEARCHENGINE = YES
183SERVER_BASED_SEARCH = NO
184#---------------------------------------------------------------------------
185# configuration options related to the LaTeX output
186#---------------------------------------------------------------------------
187GENERATE_LATEX = NO
188LATEX_OUTPUT = latex
189LATEX_CMD_NAME = latex
190MAKEINDEX_CMD_NAME = makeindex
191COMPACT_LATEX = NO
192PAPER_TYPE = a4wide
193EXTRA_PACKAGES =
194LATEX_HEADER =
195LATEX_FOOTER =
196PDF_HYPERLINKS = YES
197USE_PDFLATEX = YES
198LATEX_BATCHMODE = NO
199LATEX_HIDE_INDICES = NO
200LATEX_SOURCE_CODE = NO
201LATEX_BIB_STYLE = plain
202#---------------------------------------------------------------------------
203# configuration options related to the RTF output
204#---------------------------------------------------------------------------
205GENERATE_RTF = NO
206RTF_OUTPUT = rtf
207COMPACT_RTF = NO
208RTF_HYPERLINKS = NO
209RTF_STYLESHEET_FILE =
210RTF_EXTENSIONS_FILE =
211#---------------------------------------------------------------------------
212# configuration options related to the man page output
213#---------------------------------------------------------------------------
214GENERATE_MAN = NO
215MAN_OUTPUT = man
216MAN_EXTENSION = .3
217MAN_LINKS = NO
218#---------------------------------------------------------------------------
219# configuration options related to the XML output
220#---------------------------------------------------------------------------
221GENERATE_XML = NO
222XML_OUTPUT = xml
223XML_SCHEMA =
224XML_DTD =
225XML_PROGRAMLISTING = YES
226#---------------------------------------------------------------------------
227# configuration options for the AutoGen Definitions output
228#---------------------------------------------------------------------------
229GENERATE_AUTOGEN_DEF = NO
230#---------------------------------------------------------------------------
231# configuration options related to the Perl module output
232#---------------------------------------------------------------------------
233GENERATE_PERLMOD = NO
234PERLMOD_LATEX = NO
235PERLMOD_PRETTY = YES
236PERLMOD_MAKEVAR_PREFIX =
237#---------------------------------------------------------------------------
238# Configuration options related to the preprocessor
239#---------------------------------------------------------------------------
240ENABLE_PREPROCESSING = YES
241MACRO_EXPANSION = NO
242EXPAND_ONLY_PREDEF = NO
243SEARCH_INCLUDES = YES
244INCLUDE_PATH =
245INCLUDE_FILE_PATTERNS =
246PREDEFINED =
247EXPAND_AS_DEFINED =
248SKIP_FUNCTION_MACROS = YES
249#---------------------------------------------------------------------------
250# Configuration::additions related to external references
251#---------------------------------------------------------------------------
252TAGFILES =
253GENERATE_TAGFILE =
254ALLEXTERNALS = NO
255EXTERNAL_GROUPS = YES
256PERL_PATH = /usr/bin/perl
257#---------------------------------------------------------------------------
258# Configuration options related to the dot tool
259#---------------------------------------------------------------------------
260CLASS_DIAGRAMS = YES
261MSCGEN_PATH =
262HIDE_UNDOC_RELATIONS = YES
263HAVE_DOT = NO
264DOT_NUM_THREADS = 0
265DOT_FONTNAME = Helvetica
266DOT_FONTSIZE = 10
267DOT_FONTPATH =
268CLASS_GRAPH = YES
269COLLABORATION_GRAPH = YES
270GROUP_GRAPHS = YES
271UML_LOOK = NO
272UML_LIMIT_NUM_FIELDS = 10
273TEMPLATE_RELATIONS = NO
274INCLUDE_GRAPH = YES
275INCLUDED_BY_GRAPH = YES
276CALL_GRAPH = NO
277CALLER_GRAPH = NO
278GRAPHICAL_HIERARCHY = YES
279DIRECTORY_GRAPH = YES
280DOT_IMAGE_FORMAT = png
281INTERACTIVE_SVG = NO
282DOT_PATH =
283DOTFILE_DIRS =
284MSCFILE_DIRS =
285DOT_GRAPH_MAX_NODES = 50
286MAX_DOT_GRAPH_DEPTH = 0
287DOT_TRANSPARENT = YES
288DOT_MULTI_TARGETS = NO
289GENERATE_LEGEND = YES
290DOT_CLEANUP = YES
generated by cgit v1.1 at 2024-11-17 21:19:51 +0000