doxygen-docs

[jj_spike]

Hello all,

I made the move from Cygwin to a dedicated Suse Linux install. Let me tell you, the speed is far greater and the little update and other problems simply do not exist.

There is still one problem, I cannot generate the SDK documentation. No matter what I enter for the make, I receive the target does not exist error. I am running the an SDK and toolchain that I downloaded just yesterday. This has been a problem for me from the start. Can anyone assist? I would like to generate the PDF version of the SDK functions.

Best regards,

JJ

[Agoln]

in the PSPSDK folder, if you do a 'make doxygen-doc', it says that it has no rule for doxygen-doc?

BTW: Welcome to the more stable, better OS... Linux :).

(Now if we could only get you to a debian-based distro, like ubuntu ;-P )

[jj_spike]

Actually, I was a Linux guy many years back. I built my first firewall manually with RedHat and ipfwadm MANY years ago. At over 900 rules, it was quite the script. Things have come a long way since then. I use XP as my desktop platform since all of my multimedia and "Enterprise" apps work only on Wintel platforms. I am now using my spare Asus Pundit-R as a Linux desktop since if does not take up too much room. The latest Suse with KDE is quite slick I must say.

The exact error reads:
linux:/home/user1/pspsdk-1.0+beta # make doxygen-doc
make: *** No rule to make target `doc/doxygen.cfg', needed by `doc/pspsdk.tag'. Stop.

I have not coded C for over 18 years. I thought this would be a good re-introduction.

Thanks!

JJ

[ector]

That's an old problem that has been fixed. Don't use the "Beta" psp sdk, just get oopo's toolchain script from http://www.oopo.net/consoledev/ and run it to install the toolchain and pspsdk.

[jj_spike]

I ran the "toolchain.sh" and all items were built. For the life of me, I cannot locate the documentation that was created. Can anyone tell me where the documentation is stored?

Thanks

[jason867]

I would also like to know where the documentation is stored in the installation.

[Agoln]

if you do a checkout of the svn repository (svn checkout svn://svn.pspdev.org/psp/trunk/pspsdk), then you should be able to do a 'make doxygen-doc') and have it work.

[statikeffeck]

I can compile any PSP programs without any problems. However I can't compile the docs using the posted instructions. I basically just want to look at the docs for libgu for graphics drawing and manipulation. (a google search for libgu comes up with practically nothing).

I created a new directory called "test1" in my CYGWIN environment.
in test1, I used the command
$> svn checkout svn://svn.pspdev.org/psp/trunk/pspsdk

When it was finished, I had a new directory called pspsdk.
In that dir, I did
$> make doxygen-doc

Received error:
make: *** No rule to make target `doxygen-doc'. Stop.

The directory pspsdk/doc is empty, as well as the pspsdk/doc/html directory is empty.

[Agoln]

in test1, I used the command
$> svn checkout svn://svn.pspdev.org/psp/trunk/pspsdk

Good plan

When it was finished, I had a new directory called pspsdk.
In that dir, I did
$> make doxygen-doc

do a ./bootstrap first

[statikeffeck]

Thanks.
Besides ./bootstrap, I also had to run ./configure (not sure why).
Summary for newbies to get full current docs:

> svn checkout svn://svn.pspdev.org/psp/trunk/pspsdk
> cd pspsdk
> ./bootstrap
> ./configure (might be optional step)
> ./make doxygen-doc

Open pspsdk/docs/html/index.html in a web browser.

[mrbrown]

Thanks for repeating information found in the PSPSDK README.

[remleduff]

Here are a couple of toolchain fixes that might be useful.

Specifically, I think it makes more sense for the doc directory to end up in /usr/local/pspdev/psp/sdk/doc instead of being left in the downloaded directory (which is deleted when the toolchain script finishes).

Also, I changed the toolchain script to automatically build the docs when the sdk is updated (I don't think leaving old documentation around makes sense when using new code).

There's also a small fix to quiet the toolchain script when it tests for missing commands.

Without I get errors that I don't care about since I have "make" and "patch" installed:
./toolchain.sh: line 73: gmake: command not found
./toolchain.sh: line 85: gpatch: command not found

psptoolchain diff:

Code: Select all

Index: toolchain.sh
===================================================================
--- toolchain.sh        (revision 848)
+++ toolchain.sh        (working copy)
@@ -61,7 +61,7 @@

   # Newlib depends on PSPSDK headers, so if it's being built
   # then make sure that PSPSDK is being built.
-  if test $BUILD_NEWLIB ; then
+  if test $BUILD_NEWLIB; then
    BUILD_PSPSDK=1
   fi

@@ -70,10 +70,10 @@
  ###########################

   ## Check for make.
-  if test "`gmake -v`" ; then
+  if test "`gmake -v 2>/dev/null`" ; then
    MAKE="gmake"
   else
-   if test "`make -v`" ; then
+   if test "`make -v 2>/dev/null`" ; then
     MAKE="make"
    else
     echo "ERROR: Please make sure you have GNU 'make' installed."
@@ -82,10 +82,10 @@
   fi

   ## Check for patch.
-  if test "`gpatch -v`" ; then
+  if test "`gpatch -v 2>/dev/null`" ; then
    PATCH="gpatch -p1"
   else
-   if test "`patch -v`" ; then
+   if test "`patch -v 2>/dev/null`" ; then
     PATCH="patch -p1"
    else
     echo "ERROR: Please make sure you have 'patch' installed."
@@ -94,7 +94,7 @@
   fi

   ## Check for wget.
-  if test "`wget -V`" ; then
+  if test "`wget -V 2>/dev/null`" ; then
    WGET="wget --passive-ftp"
   else
    echo "ERROR: Please make sure you have 'wget' installed."
@@ -102,7 +102,7 @@
   fi

   ## Check for subversion.
-  if test "`svn help`" ; then
+  if test "`svn help 2>/dev/null`" ; then
    SVN="svn"
   else
    echo "ERROR: Please make sure you have 'subversion (svn)' installed."
@@ -331,6 +331,8 @@
    ## Install the result.
    $MAKE install || { echo "ERROR INSTALLING PSPSDK"; exit; }

+   $MAKE doxygen-doc || { echo "ERROR MAKING DOXYGEN DOCS"; exit; }
+
    ## Clean up the result.
    $MAKE clean

pspsdk diff:

Code: Select all

Index: configure.ac
===================================================================
--- configure.ac        (revision 847)
+++ configure.ac        (working copy)
@@ -34,17 +34,6 @@
 AC_FUNC_MEMCMP
 AC_CHECK_FUNCS([getcwd strchr])

-# Doxygen.
-DX_HTML_FEATURE(ON)
-DX_CHM_FEATURE(OFF)
-DX_CHI_FEATURE(OFF)
-DX_MAN_FEATURE(OFF)
-DX_RTF_FEATURE(OFF)
-DX_XML_FEATURE(OFF)
-DX_PDF_FEATURE(OFF)
-DX_PS_FEATURE(OFF)
-DX_INIT_DOXYGEN(pspsdk, doxygen.cfg, doc)
-
 # Override the default prefix to point to where the pspdev tools should be installed.
 # The binaries will end up in $prefix/bin, but pspsdk itself will end up in $prefix/$target/sdk.
 # TODO: We should see if the user will ever want to override this.
@@ -71,6 +60,17 @@
 AC_SUBST(PSPSDK_CFLAGS)
 AC_SUBST(PSPSDK_CXXFLAGS)

+# Doxygen.
+DX_HTML_FEATURE(ON)
+DX_CHM_FEATURE(OFF)
+DX_CHI_FEATURE(OFF)
+DX_MAN_FEATURE(OFF)
+DX_RTF_FEATURE(OFF)
+DX_XML_FEATURE(OFF)
+DX_PDF_FEATURE(OFF)
+DX_PS_FEATURE(OFF)
+DX_INIT_DOXYGEN(pspsdk, doxygen.cfg, "$pspsdk/doc")
+
 # Turn on all warnings (for host programs).
 if test x$ac_compiler_gnu = xyes; then
    CFLAGS="$CFLAGS -Wall"

[ooPo]

I've updated the toolchain.sh in svn as suggested with some minor modifications.

[remleduff]

Looks great, thanks. :)

Without the change to configure.ac in pspsdk, the docs will just be immediately "cleaned up" at the end of the toolchain script because they'll be installed in "/tmp/pspsdev/pspsdk/doc" by default.

[jimparis]

The toolchain script now copies the built docs to /usr/local/pspdev/psp/sdk/doc, so if you have doxygen installed when you build the toolchain, you should be able to point your browser to [url]file:///usr/local/pspdev/psp/sdk/doc/html/index.html[/url] when it's done.

[Panajev2001a]

I use the toolchain script (the perl based one) and no docs directory is created (just checked).