- I wish svn delete would..delete the file -before- committing to that testing before...
authorAlex Ionescu <aionescu@gmail.com>
Tue, 22 Nov 2005 08:21:42 +0000 (08:21 +0000)
committerAlex Ionescu <aionescu@gmail.com>
Tue, 22 Nov 2005 08:21:42 +0000 (08:21 +0000)
- Update NDK text files.

svn path=/trunk/; revision=19459

reactos/include/ndk/fixmes.txt
reactos/include/ndk/readme.txt
reactos/lib/wdmguid/wdmguid.c

index 6d1e973..6d94635 100644 (file)
@@ -1,8 +1,135 @@
 Complete list of NDK Fixmes before 1.0 Release (Nov 25th 2005)\r
 --------------------------------------------------------------\r
+______________________________________________________________________________________\r
+[CRITICAL]     - Breaking compatibility with official structures.\r
+|pstypes.h     - EPROCESS has ReactOS only fields. Includes ReactOS Internal header.\r
+|pstypes.h     - W32_CALLOUT_DATA has ReactOS only fields.\r
+|obtypes.h     - Object callbacks are ReactOS only definitions.\r
+|obtypes.h     - Object Header includes ReactOS only type.\r
+|mmtypes.h     - _MADDRESS_SPACE is ReactOS only field.\r
+|ketypes.h     - _KPROFILE needs to be updated with new definitions.\r
+|ketypes.h     - _KINTERRUPT needs to be verified with new definitions.\r
+|haltypes.h    - Loader Parameter Block is ReactOS Version, not NT.\r
+|\r
+[MAJOR]                - Using incorrect, missing, or invalid names or definitions.\r
+|i386/ketypes.h        - _KTRAP_FRAME definition is broken.\r
+|i386/ketypes.h        - _KTSSNOIOPM is not an official type.\r
+|rtltypes.h    - PPF_ Defines don't seem to be the real names (try to find them).\r
+|rtltypes.h    - _RTL_PROCESS_BACKTRACE_INFORMATION isn't done.\r
+|haltypes.h    - Multi-Boot flags are ReactOS Only.\r
+|extypes.h     - SystemPowerInformation in SYSTEM_INFORMATION_CLASS causes conflict.\r
+|extypes.h     - _RUNDOWN_DESCRIPTOR is possibly incorrect/unofficial.\r
+|asm.h         - Selector names are not official.\r
+|extypes.h     - Class 42 (SYSTEM_POWER_INFORMATION causes conflict).\r
+|extypes.h     - Classes 13, 20, 30, 31, 49, 51, 52, 54+ are undefined.\r
+|\r
+[MINOR]                - Related to location of functions, comments, etc.\r
+|arch/ketypes.h        - _KDPC_DATA, PP_LOOKASIDE_LIST shouldn't be there.\r
+|zwfuncs.h     - APIs are not organized.\r
+|pstypes.h     - Check if _PAGEFAULT_HISTORY shouldn't go in mmtypes.h instead.\r
+|lpctypes.h    - Consider moving _HARDERROR_MSG to extypes.h?\r
+|lpctypes.h    - Consider moving _CLIENT_DIED_MSG to pstypes.h?\r
+|ketypes.h     - Consider moving KNODE to mmtypes.h?\r
+|ketypes.h     - Consider moving NtBuildNumber to extypes.h?\r
+|extypes.h     - consider moving PORT_ALL_ACCESS to lpctypes.h\r
+|GENERIC       - Make sure that all files can be included in standalone!\r
+|_____________________________________________________________________________________\r
 \r
 \r
 List of ReactOS Applications compiling with the NDK\r
+(verify, fix, and optimize their usage)\r
 --------------------------------------------------------------\r
 \r
-\r
+apps\utils\ps\ps.c: #include <ndk/ntndk.h>\r
+drivers\dd\blue\blue.c: #include <ndk/halfuncs.h>\r
+drivers\dd\bootvid\bootvid.c: #include <ndk/ldrfuncs.h>\r
+drivers\storage\diskdump\diskdump.c: #include <ndk/extypes.h>\r
+drivers\storage\diskdump\diskdump.c: #include <ndk/rtlfuncs.h>\r
+hal\hal\hal.c: #include <ndk/halfuncs.h>\r
+hal\hal\hal.c: #include <ndk/kdfuncs.h>\r
+lib\crt\except\unwind.c: #include <ndk/umtypes.h>\r
+lib\crt\except\unwind.c: #include <ndk/extypes.h>\r
+lib\crt\except\unwind.c: #include <ndk/rtlfuncs.h>\r
+lib\dnsapi\dnsapi\stubs.c: #include <ndk/ntndk.h>\r
+lib\epsapi\enum\drivers.c: #include <ndk/ntndk.h>\r
+lib\epsapi\enum\modules.c: #include <ndk/ntndk.h>\r
+lib\epsapi\enum\processes.c: #include <ndk/ntndk.h>\r
+lib\lsasrv\lsaport.c: #include <ndk/ntndk.h>\r
+lib\lsasrv\lsasrv.c: #include <ndk/ntndk.h>\r
+lib\nt\entry_point.c: #include <ndk/ntndk.h>\r
+lib\samlib\samlib.c: #include <ndk/ntndk.h>\r
+lib\samsrv\samsrv.c: #include <ndk/ntndk.h>\r
+lib\smdll\query.c: #include <ndk/ntndk.h>\r
+lib\string\mbstowcs.c: #include <ndk/umtypes.h>\r
+lib\string\mbstowcs.c: #include <ndk/rtlfuncs.h>\r
+lib\string\sscanf.c: #include <ndk/umtypes.h>\r
+lib\string\sscanf.c: #include <ndk/rtlfuncs.h>\r
+lib\string\wcstombs.c: #include <ndk/umtypes.h>\r
+lib\string\wcstombs.c: #include <ndk/rtlfuncs.h>\r
+lib\syssetup\install.c: #include <ndk/ntndk.h>\r
+lib\syssetup\logfile.c: #include <ndk/ntndk.h>\r
+lib\wdmguid\wdmguid.c: #include <ndk/sysguid.h>\r
+regtests\shared\regtests.c: #include <ndk/ntndk.h>\r
+services\umpnpmgr\umpnpmgr.c: #include <ndk/ntndk.h>\r
+subsys\csr\main.c: #include <ndk/ntndk.h>\r
+subsys\ntvdm\ntvdm.c: #include <ndk/ntndk.h>\r
+subsys\system\autochk\autochk.c: #include <ndk/ntndk.h>\r
+subsys\system\lsass\lsass.c: #include <ndk/ntndk.h>\r
+subsys\system\setup\setup.c: #include <ndk/ntndk.h>\r
+subsys\system\sm\sm.c: #include <ndk/ntndk.h>\r
+boot\freeldr\freeldr\include\freeldr.h: #include <ndk/ntndk.h>\r
+drivers\fs\ms\msfs.h: #include <ndk/ntndk.h>\r
+drivers\fs\np\npfs.h: #include <ndk/iotypes.h>\r
+drivers\fs\vfat\vfat.h: #include <ndk/ntndk.h>\r
+drivers\net\ndis\include\ndissys.h: #include <ndk/ntndk.h>\r
+drivers\net\tcpip\include\precomp.h: #include <ndk/ntndk.h>\r
+drivers\video\miniport\xboxvmp\xboxvmp.h: #include <ndk/ntndk.h>\r
+drivers\video\videoprt\videoprt.h: #include <ndk/ntndk.h>\r
+hal\halx86\include\hal.h: #include <ndk/ntndk.h>\r
+include\drivers\diskdump\diskdump.h: #include <ndk/ntndk.h>\r
+lib\advapi32\advapi32.h: #include <ndk/ntndk.h>\r
+lib\crt\precomp.h: #include <ndk/ntndk.h>\r
+lib\dbghelp\stackframe.h: #include <ndk/umtypes.h>\r
+lib\dbghelp\stackframe.h: #include <ndk/extypes.h>\r
+lib\dbghelp\stackframe.h: #include <ndk/rtlfuncs.h>\r
+lib\dnsapi\dnsapi\precomp.h: #include <ndk/ntndk.h>\r
+lib\fmifs\precomp.h: #include <ndk/ntndk.h>\r
+lib\fslib\vfatlib\vfatlib.h: #include <ndk/ntndk.h>\r
+lib\fslib\vfatxlib\vfatxlib.h: #include <ndk/ntndk.h>\r
+lib\gdi32\include\precomp.h: #include <ndk/ntndk.h>\r
+lib\imagehlp\precomp.h: #include <ndk/umtypes.h>\r
+lib\imagehlp\precomp.h: #include <ndk/rtlfuncs.h>\r
+lib\iphlpapi\iphlpapi_private.h: #include <ndk/ntndk.h>\r
+lib\kernel32\k32.h: #include <ndk/ntndk.h>\r
+lib\msafd\msafd.h: #include <ndk/ntndk.h>\r
+lib\ntdll\inc\ntdll.h: #include <ndk/ntndk.h>\r
+lib\opengl32\teb.h: #include <ndk/ntndk.h>\r
+lib\psapi\precomp.h: #include <ndk/ntndk.h>\r
+lib\rtl\rtl.h: #include <ndk/ntndk.h>\r
+lib\secur32\precomp.h: #include <ndk/ntndk.h>\r
+lib\setupapi\setupapi_private.h: #include <ndk/ntndk.h>\r
+lib\smlib\precomp.h: #include <ndk/ntndk.h>\r
+lib\user32\include\user32.h: #include <ndk/ntndk.h>\r
+lib\userenv\precomp.h: #include <ndk/ntndk.h>\r
+lib\ws2help\ws2help.h: #include <ndk/ntndk.h>\r
+lib\ws2_32\include\ws2_32.h: #include <ndk/ntndk.h>\r
+lib\wshirda\wshirda.h: #include <ndk/ntndk.h>\r
+ntoskrnl\include\ntoskrnl.h: #include <ndk/ntndk.h>\r
+ntoskrnl\include\internal\napi.h: #include <ndk/asm.h>\r
+services\dhcp\include\rosdhcp.h: #include <ndk/ntndk.h>\r
+services\eventlog\eventlog.h: #include <ndk/ntndk.h>\r
+services\rpcss\rpcss.h: #include <ndk/ntndk.h>\r
+subsys\csr\csrsrv\srv.h: #include <ndk/ntndk.h>\r
+subsys\csrss\csrss.h: #include <ndk/ntndk.h>\r
+subsys\csrss\include\api.h: #include <ndk/ntndk.h>\r
+subsys\csrss\win32csr\w32csr.h: #include <ndk/ntndk.h>\r
+subsys\smss\smss.h: #include <ndk/ntndk.h>\r
+subsys\system\cmd\precomp.h: #include <ndk/ntndk.h>\r
+subsys\system\services\services.h: #include <ndk/ntndk.h>\r
+subsys\system\taskmgr\precomp.h: #include <ndk/ntndk.h>\r
+subsys\system\usetup\usetup.h: #include <ndk/ntndk.h>\r
+subsys\system\winlogon\winlogon.h: #include <ndk/ntndk.h>\r
+subsys\win\basesrv\basesrv.h: #include <ndk/ntndk.h>\r
+subsys\win\winsrv\winsrv.h: #include <ndk/ntndk.h>\r
+subsys\win32k\w32k.h: #include <ndk/ntndk.h>\r
+subsys\win32k\include\napi.h: #include <ndk/asm.h>
\ No newline at end of file
index 61085e6..a9bbc9d 100644 (file)
@@ -2,6 +2,20 @@ Native Development Kit README
         NDK 1.00\r
 -----------------------------\r
 \r
+0. PREABMLE\r
+\r
+0.1 COPYRIGHT\r
+\r
+The NDK is Copyright © 2005 Alex Ionescu.\r
+\r
+0.2 CONTACT INFORMATION\r
+\r
+The author, Alex Ionescu, may be reached through the following means:\r
+\r
+Email:         alex.ionescu@reactos.com\r
+Mail:  2246, Duvernay. H3J 2Y3. Montreal, QC. CANADA.  \r
+Phone:         (514)581-7156\r
+\r
 1. LICENSE\r
 \r
 1.1 OPEN SOURCE USAGE\r
@@ -45,8 +59,63 @@ legal action on the part of the author.
 If you are unsure of have any questions about the NDK License, please contact the\r
 author for further clarification.\r
 \r
-2. USAGE\r
-\r
-2.1 TODO (COPY FROM WIKI)\r
+2. ORIGINS OF NDK MATERIAL, AND ADDING YOUR OWN\r
+\r
+2.1 CONTRIBUTIONS AND SOURCES\r
+\r
+The NDK could not exist without the various contributions made by a variety of people\r
+and sources. The following public sources of information were lawfully used:\r
+\r
+- GNU NTIFS.H, Revision 43\r
+- W32API, Version 2.5\r
+- Microsoft Driver Development Kit 2003 SP1\r
+- Microsoft Driver Development Kit 2000\r
+- Microsoft Driver Development Kit NT 4\r
+- Microsoft Driver Development Kit WinME\r
+- Microsoft Installable File Systems Kit 2003 SP1\r
+- Microsoft Windows Debugger (WinDBG) 6.5.0003.7\r
+- Microsoft Public Symbolic Data\r
+- Microsoft Public Windows Binaries (strings)\r
+- OSR Technical Articles\r
+- Undocumented windows 2000 Secrets, a Programmer's Cookbook\r
+- Windows NT/2000 Native API Reference\r
+- Windows NT File System Internals\r
+- Windows Internals I - II\r
+- Windows Internals 4th Edition\r
+\r
+If the information contained in these sources was copyrighted, the information was not\r
+copied, but simply used as a basis for developing a compatible and identical definition.\r
+No information protected by a patent or NDA was used. All information was publically\r
+located through the Internet or purchased or licensed for lawful use.\r
+\r
+Additionally, the following people contributed to the NDK:\r
+\r
+- Eric Kohl\r
+- Filip Navara\r
+- Steven Edwards\r
+\r
+2.2 BECOMING A CONTRIBUTOR\r
+\r
+To contribute information to the NDK, simply contact the author with your new structure,\r
+definition, enumeration, or prototype. Please make sure that your addition is:\r
+\r
+1) Actually correct!\r
+2) Present in Windows NT 5, 5.1, 5.2 and/or 6.0\r
+3) Not already accessible through another public header in the DDK, IFS, WDK and/or PSDK.\r
+4) From a publically verifiable source. The author needs to be able to search for your\r
+   addition in a public information location (book, Internet, etc) and locate this definition.\r
+5) Not Reversed. Reversing a type is STRONGLY discouraged and a reversed type will more then likely\r
+   not be accepted, due to the fact that functionality and naming will be entirely guessed, and things\r
+   like unions are almost impossible to determine. It can also bring up possible legal ramifications\r
+   depending on your location. However, using a tool to dump the strings inside an executable\r
+   for the purpose of locating the actual name or definition of a structure (sometimes possible due\r
+   to ASSERTs or debugging strings) is considered 'fair use' and will be a likely candidate.\r
+\r
+If your addition satsfies these points, then please submit it, and also include whether or not\r
+you would like to be credited for it.\r
+\r
+3. USAGE\r
+\r
+3.1 TODO (COPY FROM WIKI)\r
 \r
 ... TODO ... (COPY FROM WIKI)\r
index 724b87d..9374a51 100644 (file)
@@ -5,6 +5,6 @@
 #include "initguid.h"
 
 #include <ddk/wdmguid.h>
-#include <ndk/sysguid.h>
+#include <umpnpmgr/sysguid.h>
 
 /* EOF */