Update status
[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-20050830
30 reactos/tools/wpp # Synced to Wine-20050830
31 reactos/tools/bin2res # Resource to binary converter
32 reactos/tools/winebuild # Synced to Wine-20050830
33 reactos/tools/wmc # Wine Message Compiler
34 reactos/tools/wrc # Synced to Wine-20050830
35 reactos/tools/widl # Forked at Wine-20050628
36
37 The following libraries are shared with Wine.
38
39 reactos/lib/cabinet # Synced to Wine-20050830
40 reactos/lib/comctl32 # Synced to Wine-20050830
41 reactos/lib/comdlg32 # Synced to Wine-20050830
42 reactos/lib/dbghelp #
43 reactos/lib/dinput # Forked at Wine-20050310
44 reactos/lib/dinput8 # Synced to Wine-20050830
45 reactos/lib/icmp # Synced to Wine-20050830
46 reactos/lib/iphlpapi # Out of sync
47 reactos/lib/imagehlp # Patches for BindImage need review and submission to winehq.
48 reactos/lib/msvcrt20 # Out of sync
49 reactos/lib/mpr # Synced to Wine-20050830
50 reactos/lib/msacm # Out of sync
51 reactos/lib/msimg32 # Synced to Wine-20050830
52 reactos/lib/msi # Synced to Wine-20050830
53 reactos/lib/msvideo # Out of sync
54 reactos/lib/netapi32 # Out of sync
55 reactos/lib/objsel # Synced to Wine-20050830
56 reactos/lib/odbc32 # In sync. Depends on port of Linux ODBC.
57 reactos/lib/ole32 # Synced to Wine-20050830
58 reactos/lib/oleaut32 # Synced to Wine-20050830
59 reactos/lib/oledlg # Synced to Wine-20050830
60 reactos/lib/olepro32 # Synced to Wine-20050830
61 reactos/lib/riched20 # Synced to Wine-20050830
62 reactos/lib/richedit # Synced to Wine-20050830
63 reactos/lib/rpcrt4 # Synced to Wine-20050830
64 reactos/lib/setupapi # Forked at Wine-20050524
65 reactos/lib/shell32 # Synced to Wine-20050830
66 reactos/lib/shdocvw # Synced to Wine-20050830
67 reactos/lib/shlwapi # Synced to Wine-20050830
68 reactos/lib/twain # Out of sync
69 reactos/lib/urlmon # Synced to Wine-20050830
70 reactos/lib/uxtheme # Synced to Wine-20050830
71 reactos/lib/version # Out of sync
72 reactos/lib/wininet # Out of sync
73 reactos/lib/winmm # Forked at Wine-20050628
74 reactos/lib/winmm/midimap # Forked at Wine-20050628
75 reactos/lib/winmm/wavemap # Forked at Wine-20050628
76
77 ReactOS shares the following programs with Winehq.
78 reactos/subsys/system/regedit # Out of sync
79 reactos/subsys/system/expand # Out of sync
80 reactos/subsys/system/msiexec # Synced to Wine-20050830
81
82 In addition the following libs, dlls and source files are mostly based on code ported
83 from Winehq CVS. If you are looking to update something in these files
84 check Wine current souces first as it may already be fixed.
85
86 reactos/lib/imm32 #
87 reactos/lib/uuid #
88
89 advapi32 -
90 reactos/lib/advapi32/crypt/*.c # ekohl says we're not sharing this
91
92 gdi32 -
93 reactos/lib/gdi32/objects/linedda.c # Out of sync
94
95 kernel32 -
96 reactos/lib/kernel32/misc/errormsg.c # Out of sync
97 reactos/lib/kernel32/misc/profile.c # Out of sync
98 reactos/lib/kernel32/misc/lcformat.c # Out of sync
99
100 msvcrt -
101 reactos/lib/msvcrt/wine/*.c # Out of sync
102
103 User32 -
104 reactos/lib/user32/controls/button.c # Out of sync
105 reactos/lib/user32/controls/edit.c # Out of sync
106 reactos/lib/user32/controls/static.c # Out of sync
107 reactos/lib/user32/misc/wsprintf.c # Out of sync
108 reactos/lib/user32/windows/mdi.c # Out of sync
109
110 - Cd to the parent directory of your top-level "reactos" directory
111 - Check out the Wine release: "cvs -d :pserver:cvs@cvs.winehq.com:2401/home/wine co wine -r Wine-20050211"
112 - Create "vendor" directory (as a sibling of your top-level "reactos" directory)
113 - Cd to the vendor dir and check out the current vendor drop:
114 "svn co svn://svn.reactos.com/vendor/wine".
115 - For each component shared with Wine (e.g. cabinet):
116 "del vendor\wine\dlls\cabinet\current\*"
117 "copy wine\dlls\cabinet vendor\wine\dlls\cabinet\current"
118 "del vendor\wine\dlls\cabinet\current\.cvsignore"
119 Check svn status, svn add/delete files as needed
120 Tag new Wine release "svn copy vendor\wine\dlls\cabinet\current vendor\wine\dlls\cabinet\Wine-20050211"
121 - Commit the vendor drop: svn commit vendor\wine -m "Wine-20050211 vendor drop"
122 - Determine the revision number of the last Wine tag by looking at http://svn.reactos.com/viewcvs/tags/
123 and finding the last Wine-yyyymmdd-sync tag, e.g. Wine-20050111-sync had rev 13007
124 - For each component shared with Wine (e.g. cabinet):
125 - "cd reactos\lib\cabinet"
126 - Check for changes in the ReactOS tree: "svn diff -r 13007" (13007 is the revno of the previous sync).
127 If any changes are found, see if they're present in the Wine code. If not, submit to WineHQ
128 if apropriate.
129 - Merge in Wine changes:
130 "svn merge svn://svn.reactos.com/vendor/wine/dlls/cabinet/Wine-20050111
131 svn://svn.reactos.com/vendor/wine/dlls/cabinet/current"
132 - Fix any merge conflicts
133 - Build and test (building will sometimes require adjusting header files)
134 - Check which files were changed: "svn status"
135 - For each of the changed files, get the WineHQ CVS log. Copy author and CVS commit message into a
136 commit log
137 - Commit changed files "svn commit" using generated commit log as commit message