Add files via upload #719

LifWirser · 2022-07-24T20:04:19Z

Thank you for submitting a pull request and becoming a contributor to the Vega Strike Core Engine.

Please answer the following:

Code Changes:

Have the PR Validation Tests been run? See https://github.com/vegastrike/Vega-Strike-Engine-Source/wiki/Pull-Request-Validation
[ X] This is a documentation change only

Issues:

Please list any related 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

BenjamenMeyer

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.

BenjamenMeyer · 2022-07-25T16:46:38Z

doc/doc/AUTHORS

@@ -0,0 +1,51 @@
+Vega Strike
+http://vegastrike.sourceforge.net


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

LifWirser · 2022-08-22T19:50:00Z

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

LifWirser · 2022-08-22T20:02:37Z

If I am seing corredtly all should fixed

stephengtuggy · 2022-08-23T03:23:16Z

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.

BenjamenMeyer

Please restore doc/AUTHORS for this PR, and let's explore that in its own PR

doc/AUTHORS

Replaced /doc/AUTHORS, per request to handle seperate issue not yet entered

stephengtuggy

Looks good to me.

vincele

This will need significant work to be mergeable, but anyways thanks for the effort.
Be careful with your whitespace, and try to use a spell checker, it should help.

vincele · 2022-12-29T10:03:30Z

doc/DOCUMENTATION


 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 


degugging ?

vincele · 2022-12-29T10:05:13Z

doc/DOCUMENTATION


-For more Details please see the doxygen Documentation.
+For more Details please see the 
+  doxygen Documentation- {VS_root}/doc/VS_Doxygen.RDME .


"Documentation-" ?
remove the dot

vincele · 2022-12-29T10:06:37Z

doc/VS_Doxygen.RDME

@@ -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.


is the added whitespace at start intended ?
"directory run" remove doubled space

vincele · 2022-12-29T10:08:11Z

doc/VS_Doxygen.RDME

+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.


"Requires: doxygen" remove doubled space

vincele · 2022-12-29T10:09:10Z

doc/VS_Gdb_Python.RDME

@@ -0,0 +1,93 @@
+In order to properly setup and use gdb with pythonon the "vegastrike-engine", some things need to happen.


maybe "python on" ?

vincele · 2022-12-29T14:23:26Z

doc/VS_Valgrind.RDME

+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.


whitespace damage, again
what is a suppression tag ?

vincele · 2022-12-29T14:24:13Z

doc/VS_Valgrind.RDME

+     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


Ah, this may be it...

vincele · 2022-12-29T14:25:06Z

doc/VS_Valgrind.RDME

+      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"


"simular to" => "like this"

vincele · 2022-12-29T14:25:41Z

doc/VS_Valgrind.RDME

+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


remove this line

vincele · 2022-12-29T14:27:34Z

doc/doxygen/notes_Doxy

@@ -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)


doxyhen => doxygen
originally in ./engine
relative
whitespace damage (multiple instances)

vincele · 2022-12-29T14:34:13Z

Also the PR title does not explain what this is about, please fix it

BenjamenMeyer

Generally looks good; but please fix @vincele 's comments.

royfalk · 2024-10-02T06:21:56Z

What's the status of this PR? It looks like it's 90% done.

stephengtuggy · 2025-03-14T20:31:55Z

@LifWirser it would be great if you could take a look at fixing the typos @vincele noted. (Also, please merge in the latest changes from master.) Then we could get this PR merged. As @royfalk noted, it's 90% finished. Let's get it across the finish line.

I shouldn't have approved this originally. There are a number of typos.

vincele · 2025-04-03T17:47:10Z

doc/VS_Gdb_Python.RDME

+enter this at ">>>" prompt 
+
+>>> import os
+>>> print('I am pid ()'.format(os.getpid()))


Suggested change

>>> print('I am pid ()'.format(os.getpid()))

>>> print('I am pid {}'.format(os.getpid()))

vincele · 2025-04-03T17:47:31Z

doc/VS_Gdb_Python.RDME

+
+>>> import os
+>>> print('I am pid ()'.format(os.getpid()))
+I am pid ()


Suggested change

I am pid ()

I am pid 19612

royfalk · 2025-06-22T04:21:58Z

@LifWirser should someone else take over this?

Add files via upload

fbfb606

BenjamenMeyer requested changes Jul 25, 2022

View reviewed changes

LifWirser added 6 commits August 22, 2022 14:41

Delete doc/doc/man directory

8cef17b

Repair pull request - remove /doc/doc/man

Delete AUTHORS

615b368

Delete CMakeLists.txt

30b3ddd

Delete DOCUMENTATION

814e578

Delete ChangeLog

e97ea56

Update VS_Doxygen.RDME

4a1f1ea

corrected doxygen command

LifWirser added 4 commits August 22, 2022 15:50

Delete AUTHORS

046a4f4

Delete doc/doc/doxygen directory

9ccd384

Delete doc/doc directory

b96b90f

correcting pull request

Add files via upload

27c2818

Correct errored pulln request

Delete doxygenConfig

1142c92

BenjamenMeyer requested changes Aug 23, 2022

View reviewed changes

doc/AUTHORS Show resolved Hide resolved

Add files via upload

62aab0f

Replaced /doc/AUTHORS, per request to handle seperate issue not yet entered

LifWirser mentioned this pull request Aug 23, 2022

Update /relocate VSE/engine /doxygen.config #705

Closed

stephengtuggy previously approved these changes Aug 24, 2022

View reviewed changes

BenjamenMeyer mentioned this pull request Aug 24, 2022

incorperate doxygen options into }VSE|/engine/CMakeLists.txt #730

Open

vincele requested changes Dec 29, 2022

View reviewed changes

BenjamenMeyer requested changes Nov 9, 2023

View reviewed changes

stephengtuggy self-requested a review March 14, 2025 20:32

vincele reviewed Apr 3, 2025

View reviewed changes

		@@ -0,0 +1,51 @@
		Vega Strike
		http://vegastrike.sourceforge.net


		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

		@@ -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.

		@@ -0,0 +1,93 @@
		In order to properly setup and use gdb with pythonon the "vegastrike-engine", some things need to happen.

		@@ -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)

	>>> print('I am pid ()'.format(os.getpid()))
	>>> print('I am pid {}'.format(os.getpid()))

Uh oh!

Add files via upload #719

Are you sure you want to change the base?

Add files via upload #719

Uh oh!

Conversation

LifWirser commented Jul 24, 2022

Uh oh!

BenjamenMeyer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LifWirser commented Aug 22, 2022

Uh oh!

LifWirser commented Aug 22, 2022

Uh oh!

stephengtuggy commented Aug 23, 2022

Uh oh!

BenjamenMeyer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stephengtuggy left a comment

Choose a reason for hiding this comment

Uh oh!

vincele left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vincele commented Dec 29, 2022

Uh oh!

BenjamenMeyer left a comment

Choose a reason for hiding this comment

Uh oh!

royfalk commented Oct 2, 2024

Uh oh!

stephengtuggy commented Mar 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

royfalk commented Jun 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants