- Fix some formatting.
[reactos.git] / reactos / media / doc / README.WINE
1 # ReactOS WINE porting guide for 0.3
2 # Update this file when you port a dll/program from WINE.
3
4 The ReactOS Project shares quite a bit of code with the WINE project.
5 This document should provide a compleate reference for all of the
6 locations in the ReactOS source tree where code is shared between the
7 two projects. If you find something is missing from this documentation
8 please add it.
9
10 If you find that a function in ReactOS that is not implemented properly
11 and is based on WINE sources, check the latest Winehq CVS and see if
12 it has been fixed there. If so, please submit a patch to
13 ros-dev@reactos.com. Otherwise please send a patch to both
14 wine-patches@winehq.com and ros-dev@reactos.com
15
16 When porting a dll from WINE to ReactOS please take a look at how
17 comctl32 has been imported. We start by creating a makefile that has
18 a target defined like so:
19
20 TARGET_TYPE = winedll
21
22 This will cause the reactos build system to look for a file called
23 makefile.ros-template. This file contains all of the information needed
24 for the ReactOS build system to make use of the WINE Makefile.in.
25 This will allow you to use the WINE tools and librarys with very little
26 work to import a new dll.
27
28 The following build tools are shared with Wine.
29 reactos/tools/unicode # Synced to Wine-0_9_4
30 reactos/tools/wpp # Synced to Wine-0_9_4
31 reactos/tools/bin2res # Resource to binary converter
32 reactos/tools/winebuild # Synced to Wine-0_9_4
33 reactos/tools/wmc # Synced to Wine-0_9_4
34 reactos/tools/wrc # Synced to Wine-0_9_4
35 reactos/tools/widl # Forked at Wine-20050930
36
37 The following libraries are shared with Wine.
38
39 reactos/lib/avifil32 # Synced to Wine-0_9_4
40 reactos/lib/cabinet # Synced to Wine-0_9_4
41 reactos/lib/comctl32 # Synced to Wine-0_9_4
42 reactos/lib/comdlg32 # Synced to Wine-0_9_4
43 reactos/lib/crypt32 # Synced to Wine-0_9_4
44 reactos/lib/dbghelp #
45 reactos/lib/dinput # Synced to Wine-0_9_4
46 reactos/lib/dinput8 # Synced to Wine-0_9_4
47 reactos/lib/dplay # Synced to Wine-0_9_4
48 reactos/lib/dplayx # Synced to Wine-0_9_4
49 reactos/lib/dxdiagn # Synced to Wine-0_9_4
50 reactos/lib/icmp # Synced to Wine-0_9_4
51 reactos/lib/imm32 # Synced to Wine-0_9_4
52 reactos/lib/iphlpapi # Out of sync
53 reactos/lib/imagehlp # Patches for BindImage need review and submission to winehq.
54 reactos/lib/msvcrt20 # Out of sync
55 reactos/lib/mpr # Synced to Wine-0_9_4
56 reactos/lib/msacm # Out of sync
57 reactos/lib/msimg32 # Synced to Wine-0_9_4
58 reactos/lib/msi # Synced to Wine-0_9_4
59 reactos/lib/msvideo # Out of sync
60 reactos/lib/netapi32 # Synced to Wine-0_9_4
61 reactos/lib/objsel # Synced to Wine-0_9_4
62 reactos/lib/odbc32 # Out of sync. Depends on port of Linux ODBC.
63 reactos/lib/ole32 # Synced to Wine-0_9_4
64 reactos/lib/oleacc # Synced to Wine-0_9_4
65 reactos/lib/oleaut32 # Synced to Wine-0_9_4
66 reactos/lib/oledlg # Synced to Wine-0_9_4
67 reactos/lib/olepro32 # Synced to Wine-0_9_4
68 reactos/lib/riched20 # Synced to Wine-0_9_4
69 reactos/lib/richedit # Synced to Wine-0_9_4
70 reactos/lib/rpcrt4 # Synced to Wine-0_9_4
71 reactos/lib/setupapi # Forked at Wine-20050524
72 reactos/lib/shell32 # Synced to Wine-0_9_4
73 reactos/lib/shdocvw # Synced to Wine-0_9_4
74 reactos/lib/shfolder # Synced to Wine-0_9_4
75 reactos/lib/shlwapi # Synced to Wine-0_9_4
76 reactos/lib/twain # Out of sync
77 reactos/lib/urlmon # Synced to Wine-0_9_4
78 reactos/lib/uxtheme # Synced to Wine-0_9_4
79 reactos/lib/version # Out of sync
80 reactos/lib/wininet # Out of sync
81 reactos/lib/winmm # Forked at Wine-20050628
82 reactos/lib/winmm/midimap # Forked at Wine-20050628
83 reactos/lib/winmm/wavemap # Forked at Wine-20050628
84
85 ReactOS shares the following programs with Winehq.
86 reactos/subsys/system/regedit # Out of sync
87 reactos/subsys/system/expand # Out of sync
88 reactos/subsys/system/msiexec # Synced to Wine-0_9_3
89
90 In addition the following libs, dlls and source files are mostly based on code ported
91 from Winehq CVS. If you are looking to update something in these files
92 check Wine current souces first as it may already be fixed.
93
94 reactos/lib/uuid #
95
96 advapi32 -
97 reactos/lib/advapi32/crypt/*.c # ekohl says we're not sharing this
98
99 gdi32 -
100 reactos/lib/gdi32/objects/linedda.c # Out of sync
101
102 kernel32 -
103 reactos/lib/kernel32/misc/errormsg.c # Out of sync
104 reactos/lib/kernel32/misc/profile.c # Out of sync
105 reactos/lib/kernel32/misc/lcformat.c # Out of sync
106
107 msvcrt -
108 reactos/lib/msvcrt/wine/*.c # Out of sync
109
110 User32 -
111 reactos/lib/user32/controls/button.c # Out of sync
112 reactos/lib/user32/controls/edit.c # Out of sync
113 reactos/lib/user32/controls/static.c # Out of sync
114 reactos/lib/user32/misc/wsprintf.c # Out of sync
115 reactos/lib/user32/windows/mdi.c # Out of sync
116
117 - Cd to the parent directory of your top-level "reactos" directory
118 - Check out the Wine release: "cvs -d :pserver:cvs@cvs.winehq.com:2401/home/wine co wine -r Wine-20050211"
119 - Create "vendor" directory (as a sibling of your top-level "reactos" directory)
120 - Cd to the vendor dir and check out the current vendor drop:
121 "svn co svn://svn.reactos.com/vendor/wine".
122 - For each component shared with Wine (e.g. cabinet):
123 "del vendor\wine\dlls\cabinet\current\*"
124 "copy wine\dlls\cabinet vendor\wine\dlls\cabinet\current"
125 "del vendor\wine\dlls\cabinet\current\.cvsignore"
126 Check svn status, svn add/delete files as needed
127 Tag new Wine release "svn copy vendor\wine\dlls\cabinet\current vendor\wine\dlls\cabinet\Wine-20050211"
128 - Commit the vendor drop: svn commit vendor\wine -m "Wine-20050211 vendor drop"
129 - Determine the revision number of the last Wine tag by looking at http://svn.reactos.com/viewcvs/tags/
130 and finding the last Wine-yyyymmdd-sync tag, e.g. Wine-20050111-sync had rev 13007
131 - For each component shared with Wine (e.g. cabinet):
132 - "cd reactos\lib\cabinet"
133 - Check for changes in the ReactOS tree: "svn diff -r 13007" (13007 is the revno of the previous sync).
134 If any changes are found, see if they're present in the Wine code. If not, submit to WineHQ
135 if apropriate.
136 - Merge in Wine changes:
137 "svn merge svn://svn.reactos.com/vendor/wine/dlls/cabinet/Wine-20050111
138 svn://svn.reactos.com/vendor/wine/dlls/cabinet/current"
139 - Fix any merge conflicts
140 - Build and test (building will sometimes require adjusting header files)
141 - Check which files were changed: "svn status"
142 - For each of the changed files, get the WineHQ CVS log. Copy author and CVS commit message into a
143 commit log
144 - Commit changed files "svn commit" using generated commit log as commit message