Changeset 83 for pa_proposals/trunk/021-NewDirectoryStructure.html

Timestamp:

02/20/04 07:34:41 (5 years ago)

Author:

rossbencina

Message:

- renamings: macos_x -> mac_osx, macos_789 -> mac_classic, AL -> al, wmme -> mme, sndmgr -> sm
WMME was renamed MME due to <100 vs 56000 hits on google for "wmme sound" vs "mme sound"
- added disucssion regarding removing /src and hoisting its contents
- listed separate vc6 and vc7 build directories

Files:

• pa_proposals/trunk/021-NewDirectoryStructure.html (modified) (4 diffs)

pa_proposals/trunk/021-NewDirectoryStructure.html

@@ -18 +18 @@
 <P><A href="index.html">Enhancement Proposals Index</A>,
 <A href="http://www.portaudio.com/">PortAudio Home Page</A></P>
-<P>Updated: October 27, January 2004 </P>
+<P>Updated: February 20, 2004 </P>
 
 <H4>Status</H4>
@@ -37 +37 @@
 </P>
 
+<P>The issue was raised again at the end of January 2004:<br>
+<a href="http://techweb.rfa.org/pipermail/portaudio/2004-January/003063.html">http://techweb.rfa.org/pipermail/portaudio/2004-January/003063.html</a></P>
+
 <H4>Proposal</H4>
 
 <P>
-The proposal is to use the following directory structure. At this stage there is no intention of changing the names of source files.
+The proposal is to use the directory structure listed below. Although it is not the goal of this proposal to undertake any major source-file name changes, 'wmme' will be changed to 'mme' to be more consistent with industry standards ("wmme sound" occurs < 100 times in Google, while "mme sound" has over 56000 entries).
 </P>
 
@@ -48 +51 @@
 
 /doc                                    
-        /html                           (doxygen generated HTML documentation)
-        /src                            (doxygen source files)
+    /html               (doxygen generated HTML documentation)
+    /src                (doxygen source files)
 
-/include                                (public include files)
+/include                (public include files)
     portaudio.h
-    pa_wmme.h                   (wmme extensions)
-    pa_asio.h                   (asio extensions)
+    pa_mme.h            (mme specific extensions)
+    pa_asio.h           (asio specific extensions)
 
 /src
-    /common                             (portable common infrastructure)
-    /arch                               (code common to a particular platform)
+    /common             (portable common infrastructure)
+    /os                 (code common to a particular platform)
         /win
         /unix
-        /macos_789
-        /macos_x
-    /hostapi                    (code for each host api)
+        /mac_classic
+        /mac_osx
+    /hostapi            (code for each host api)
+        /al             (IRIX al)
         /alsa
         /asio
-        /irix_al
+        /coreaudio
+        /dsound
         /jack
         /oss
-        /mac_sm
-        /mac_coreaudio
-        /win_wmme
-        /win_ds
+        /sm             (MacOS sound manager)
+        /mme
 
-/tests                          (test files)
+/tests                  (test files)
 
-/build                                  (static makefiles/project files)
-        /mingw
-        /bcb
-        /msvc6
-        /xcode
-        /dev-cpp        
+/build                  (static makefiles/project files for toolsets that don't ./configure)
+    /mingw
+    /bcb4
+    /vc6
+    /vc7
+    /xcode
+    /dev-cpp    
 
 /bindings
@@ -93 +97 @@
 
 <P>
-The current proposal is to only put public include files in the top level /include directory, with implementation include files being left in /common. Some people thought this could be confusing.
+The current proposal is to only put public include files in the top level /include directory, with implementation include files being left in /common. Some people thought this could be confusing, but it has the advantage of clearly separating PortAudio's "public interface" from its implementation internals. It was noted that the GNU configure way is to support "exported" and "private" include files in a single include directory.
 </P>
 
+<P>
+It was suggested that we remove the /src directory and place common/, os/ and hostapi/ in the root directory. The argument for this is that it makes things easier to find. On the other hand, it is good to make a clear distinction between the source, auxilliary documentation, interface headers, build configuration files and foriegn language bindings.
+</P>
 
 <H4>Impact Analysis</H4>
 
 <P>
-?
+The configure, project and Makefiles will need to be adjusted to accomodate the new directory structure.
+CVS history will be lost, although this was likely to be the case anyway with the merge back onto the HEAD.
 </P>
-
 
 </BODY>
 </HTML>
-
+
+/