Kaynağa Gözat

Documentation: Added user's guide, added link to ptw32 on main page.

Jason Schmidlapp 17 yıl önce
ebeveyn
işleme
31b47d795a
2 değiştirilmiş dosya ile 34 ekleme ve 1 silme
  1. 1 1
      doc/pte_main.html
  2. 33 0
      doc/pte_users_guide.html

+ 1 - 1
doc/pte_main.html

@@ -9,4 +9,4 @@ used to provide a pthreads API for embedded operating systems that
 do not natively provide a pthreads API. PTE is designed to be easily
 portable to such operating systems and only relies on basic primitives
 (e.g. semaphores) that are widely supported on most embedded operating
-systems.<br><br>Currently, PTE has been ported to Texas Instrument's DSP/BIOS and Sony's PSP OS.<br><br><a href="http://sourceforge.net/project/showfiles.php?group_id=213842">Download</a><br><a href="mailto:jschmidlapp@users.sourceforge.net">Contact</a><span style="font-weight: bold;"><br><br><big>Documentation</big><br></span><a href="pte_users_guide.html">User's Manual</a><span style="font-weight: bold;"><span style="font-weight: bold;"><span style="font-weight: bold;"><br></span></span></span><a href="pte_porting_guide.html">Porting Guide</a><br><a href="pte_dspbios.html">Notes on DSP/BIOS port</a><br><a href="pte_psp.html">Notes on PSP OS port</a><span style="font-weight: bold;"><span style="font-weight: bold;"><span style="font-weight: bold;"><br><br><br></span></span><br><br></span></small></small></big></big></big></body></html>
+systems.<br><br>Currently, PTE has been ported to Texas Instrument's DSP/BIOS and Sony's PSP OS.<br><br>PTE is based heavily on <a href="http://sourceware.org/pthreads-win32/">Pthreads Win32</a>, and implementation of pthreads for Windows. <br><br><a href="http://sourceforge.net/project/showfiles.php?group_id=213842">Download</a><br><a href="mailto:jschmidlapp@users.sourceforge.net">Contact</a><span style="font-weight: bold;"><br><br><big>Documentation</big><br></span><a href="pte_users_guide.html">User's Manual</a><span style="font-weight: bold;"><span style="font-weight: bold;"><span style="font-weight: bold;"><br></span></span></span><a href="pte_porting_guide.html">Porting Guide</a><br><a href="pte_dspbios.html">Notes on DSP/BIOS port</a><br><a href="pte_psp.html">Notes on PSP OS port</a><span style="font-weight: bold;"><span style="font-weight: bold;"><span style="font-weight: bold;"><br><br><br></span></span><br><br></span></small></small></big></big></big></body></html>

+ 33 - 0
doc/pte_users_guide.html

@@ -0,0 +1,33 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>PTE User's Guide</title></head><body><br><big style="font-weight: bold;"><big>PTE Users Guide</big></big><br><br>Since
+PTE is designed to be cross platform, and embedded OS's vary widely in
+their build methodology, there is no "high level" build structure
+included. &nbsp;Rather, each port is responsible for providing this.
+&nbsp;The sections below describe using PTE for a specific platform.<br><br>While
+pthreads is strictly speaking a C API, PTE does include limited support
+for C++ specific features, specifically exceptions. &nbsp;This
+functionality was primarily inherited from the original code base
+(Pthreads-win32) and has been only preliminarily tested.<br><br>An
+important component of PTE is the test library that is included.
+&nbsp;Each platform contains build files as described below to build
+the test suite.<br><big style="font-weight: bold; font-style: italic;"><br>DSP/BIOS</big><br>Texas
+Instruments provides DSP/BIOS as a RTOS to be used on their series of
+digital signal processors. &nbsp;Two project files are included: one
+for the library itself and one for the test suite. &nbsp;These projects
+(and CDB/TCF files) were targeted towards the C6000 simulator, as this
+is where I did all of the development. &nbsp;When building applications
+that use the PTE library, you will need to include pthreads.h and will
+also need to provide a path to pte-types.h (originally located in
+platforms/dspbios/pte-types.h). &nbsp;This file contains definitions of
+structures and types (e.g. pid_t) that are required by pthreads but not
+supplied by DSP/BIOS<br><big style="font-weight: bold; font-style: italic;"><br>PSP OS</big><br>This
+is the operating system used by the Sony PSP. &nbsp;The PSP toolchain
+is gcc based and thus shares many similarities with a "typical" UNIX
+system, including the build system. &nbsp;PTE includes Makefiles for
+the library itself as well as the test suite. &nbsp;Note that these
+Makefiles are pretty rudimentary as I am not anywhere close to being a
+Makefile expert. &nbsp;Thus, once the library is built it will be
+necessary to copy the library itself, pthread.h and pte-types.h to the
+appropriate places in your projects build structure. &nbsp;The PSP
+toolchain includes a pthread.h header in the base distribution (why,
+I'm not sure) - it is important that you use the pthread.hsupplied with PTE rather than the one in the toolchain. <br><br></body></html>