Add files via upload #719
Add files via upload #719
Conversation
There was a problem hiding this comment.
In addition to some of this needing to use the automation we've added (authors) or need to add (change log); this also introduces an extra unnecessary layer of directories (doc/doc).
So I'd like to see the doxygen stuff directly under doc, not doc/doc, and things simplified up a bit for easier maintenance. And please keep in mind we're going to add some automation of some of this to be as reliable as we can about it - especially authors.
doc/doc/AUTHORS
Outdated
| @@ -0,0 +1,51 @@ | |||
| Vega Strike | |||
| http://vegastrike.sourceforge.net | |||
There was a problem hiding this comment.
We've moved to using an auto-generated authors listing: https://github.com/vegastrike/Vega-Strike-Engine-Source/blob/master/script/build-authors.sh
Repair pull request - remove /doc/doc/man
corrected doxygen command
|
AUTHORS already exsisted but while I'm here I'll try to delete, I'm trying to move doxygen data to where I had intended |
correcting pull request
Correct errored pulln request
|
If I am seing corredtly all should fixed |
|
This is better. Looks like the files are in their correct directories now. However, I don't know that we need to delete the preexisting AUTHORS file. Then it will just need to be regenerated. Apart from that, this looks good. |
Replaced /doc/AUTHORS, per request to handle seperate issue not yet entered
| @@ -9,5 +9,12 @@ Star System deals with the current cameras, and the current lights, and keeping | |||
|
|
|||
| Units are accessed through a UnitContainer or a UnitCollection depending on the number. These structures keep reference counts and remove any "dead" units from them when accessed. Star system has the complete list of units and cycles through them to accomplish physics, etc. | |||
|
|
|||
| Included in this directory contains resources for generating documentation/degugging | |||
|
|
||
| For more Details please see the doxygen Documentation. | ||
| For more Details please see the | ||
| doxygen Documentation- {VS_root}/doc/VS_Doxygen.RDME . |
There was a problem hiding this comment.
"Documentation-" ?
remove the dot
| @@ -0,0 +1,6 @@ | |||
| The basic idea is first to Warn you will require lots of space if you proceed. | |||
| The basic steps are in the VSE root directory run "doxygen ./doc/doxygen/VS_doxy.Config" and all the data will be in a subdir under /doc/doxygen. the VS_doxy.config is editable (please make a bakup of the config file first, just in case. Currently it is configured to run on VegaStrike github master >"INPUT" needs to be adjusted for appropriate directoy. | |||
There was a problem hiding this comment.
is the added whitespace at start intended ?
"directory run" remove doubled space
| The basic idea is first to Warn you will require lots of space if you proceed. | ||
| The basic steps are in the VSE root directory run "doxygen ./doc/doxygen/VS_doxy.Config" and all the data will be in a subdir under /doc/doxygen. the VS_doxy.config is editable (please make a bakup of the config file first, just in case. Currently it is configured to run on VegaStrike github master >"INPUT" needs to be adjusted for appropriate directoy. | ||
|
|
||
| Requires: doxygen, Graphviz, Vegastrike {engine,assets} source packages. Lots of free storage. |
There was a problem hiding this comment.
"Requires: doxygen" remove doubled space
| @@ -0,0 +1,93 @@ | |||
| In order to properly setup and use gdb with pythonon the "vegastrike-engine", some things need to happen. | |||
| 4 edit ".valgrindrc" and comment out (with "#") the "python,python2" lines. | ||
| On my system python and python .supp files are the same. so not taking chances I comment them out ,Also the | ||
| lines of openmpi-valgrind.supp and pmix/pmix-valgrind.supp are not used in vegastrike last time I checked , | ||
| so they can be commented or given suppression tag as you see fit. |
There was a problem hiding this comment.
whitespace damage, again
what is a suppression tag ?
| On my system python and python .supp files are the same. so not taking chances I comment them out ,Also the | ||
| lines of openmpi-valgrind.supp and pmix/pmix-valgrind.supp are not used in vegastrike last time I checked , | ||
| so they can be commented or given suppression tag as you see fit. | ||
| Also insert "--suppressions=" before all other lines. DON'T FORGET TO SAVE |
| lines of openmpi-valgrind.supp and pmix/pmix-valgrind.supp are not used in vegastrike last time I checked , | ||
| so they can be commented or given suppression tag as you see fit. | ||
| Also insert "--suppressions=" before all other lines. DON'T FORGET TO SAVE | ||
| 5 run valgrind simular to "valgrind --tool=callgrind ./vegastrike-engine -d../../Assets-Production" |
There was a problem hiding this comment.
"simular to" => "like this"
| 5 run valgrind simular to "valgrind --tool=callgrind ./vegastrike-engine -d../../Assets-Production" | ||
| in this example callgrind will be run - many other options | ||
|
|
||
| I found there is a "gdb server option" but for now this will be a start |
| @@ -0,0 +1 @@ | |||
| The "doxyhen.config.orig" was originaly in /engine directory and all reletive files ,edit to run from a directory other than }VS|/engine location (VSE_root) | |||
There was a problem hiding this comment.
doxyhen => doxygen
originally in ./engine
relative
whitespace damage (multiple instances)
|
Also the PR title does not explain what this is about, please fix it |
|
What's the status of this PR? It looks like it's 90% done. |
Thank you for submitting a pull request and becoming a contributor to the Vega Strike Core Engine.
Please answer the following:
Code Changes:
Issues:
Purpose:
What is this pull request trying to do?Add support for : Doxygen, Valgrind, GDB (still incomplete
What release is this for?All
Trubleshootring code documentation