- add some documentation items

BUGS

@@ -75,7 +75,8 @@ Miscellaneous:
 
  * SGI window manager treats Wine windows as topmost.
 
- * KDE window manager puts popup windows like menus below the main window.
+ * KDE window manager and icewm put popup windows like menus
+   below the main window.
 
  * Write shows blank space instead of Paintbrush OLE1 object ( GetDIBits()? ).
 

README

@@ -131,6 +131,8 @@ see what information is required.
 
 7. GETTING MORE INFORMATION
 
+DOCU:	grep -i "SearchString" `find documentation/`|more
+
 FAQ:	The Wine FAQ is located at http://www.winehq.com/faq.html.
 
 WWW:	A great deal of information about Wine is available from WineHQ at
@@ -138,7 +140,7 @@ WWW:	A great deal of information about Wine is available from WineHQ at
 	are available on the wine-patches mailing list; see 
 	http://www.winehq.com/dev.html#ml for more information.
 
-HOWTO:	A pre-release version of the Wine HOWTO is available at
+HOWTO:	The Wine HOWTO is available at
 	http://www.westfalen.de/witch/wine-HOWTO.txt .
 
 Usenet:	Please browse old messages on http://www.dejanews.com/ to check whether 
@@ -150,6 +152,8 @@ Usenet:	Please browse old messages on http://www.dejanews.com/ to check whether
 	documentation/bugreports to see what information should be included 
 	in a bug report.
 
+IRC:	Online help is available at channel #WineHQ on IRCnet.
+
 CVS:	The current Wine development tree is available through CVS.
 	Go to http://www.winehq.com/dev.html for more information.
 

dlls/comctl32/treeview.c

@@ -98,8 +98,8 @@ TREEVIEW_EndEditLabelNow (HWND hwnd, WPARAM wParam, LPARAM lParam);
    is checked beforehand, and that tree state is valid.  */
 
 /* FIXME: MS documentation says `GetNextVisibleItem' returns NULL 
-   if not succesfull'. Probably only applies to derefencing infoPtr
-   (ie we are offered a valid treeview structure)
+   if not successfull. Probably only applies to dereferencing infoPtr
+   (i.e. we are offered a valid treeview structure)
    and not whether there is a next `visible' child. 
    FIXME: check other failures.
  */

dlls/dplayx/dplay.c

@@ -540,7 +540,7 @@ static ULONG WINAPI DirectPlay2AImpl_Release
   }
   LeaveCriticalSection( &This->unk->DP_lock );
 
-  TRACE("ref count decremeneted to %lu for %p\n", refCount, This );
+  TRACE("ref count decremented to %lu for %p\n", refCount, This );
 
   /* Deallocate if this is the last reference to the object */
   if( refCount == 0 )

dlls/ole32/storage32.c

@@ -521,7 +521,7 @@ HRESULT WINAPI StorageBaseImpl_Stat(
 {
   ICOM_THIS(StorageBaseImpl,iface);
   StgProperty    curProperty;
-  BOOL         readSucessful;
+  BOOL         readSuccessful;
 
   TRACE("(%p, %p, %lx)\n", 
 	iface, pstatstg, grfStatFlag);
@@ -535,12 +535,12 @@ HRESULT WINAPI StorageBaseImpl_Stat(
   /*
    * Read the information from the property.
    */
-  readSucessful = StorageImpl_ReadProperty(
+  readSuccessful = StorageImpl_ReadProperty(
                     This->ancestorStorage,
                     This->rootPropertySetIndex,
                     &curProperty);
 
-  if (readSucessful)
+  if (readSuccessful)
   {
     StorageUtl_CopyPropertyToSTATSTG(
       pstatstg, 
@@ -1056,7 +1056,7 @@ static ULONG getFreeProperty(
 {
   ULONG       currentPropertyIndex = 0;
   ULONG       newPropertyIndex     = PROPERTY_NULL;
-  BOOL      readSucessful        = TRUE;
+  BOOL      readSuccessful        = TRUE;
   StgProperty currentProperty;
 
   do
@@ -1064,10 +1064,10 @@ static ULONG getFreeProperty(
     /*
      * Start by reading the root property
      */
-    readSucessful = StorageImpl_ReadProperty(storage->ancestorStorage,
+    readSuccessful = StorageImpl_ReadProperty(storage->ancestorStorage,
                                                currentPropertyIndex,
                                                &currentProperty);
-    if (readSucessful)
+    if (readSuccessful)
     {
       if (currentProperty.sizeOfNameString == 0)
       {
@@ -1091,7 +1091,7 @@ static ULONG getFreeProperty(
   /* 
    * grow the property chain 
    */
-  if (! readSucessful)
+  if (! readSuccessful)
   {
     StgProperty    emptyProperty;
     ULARGE_INTEGER newSize;
@@ -2027,7 +2027,7 @@ HRESULT StorageImpl_Construct(
 {
   HRESULT     hr = S_OK;
   StgProperty currentProperty;
-  BOOL      readSucessful;
+  BOOL      readSuccessful;
   ULONG       currentPropertyIndex;
   
   if ( FAILED( validateSTGM(openFlags) ))
@@ -2175,12 +2175,12 @@ HRESULT StorageImpl_Construct(
   
   do
   {
-    readSucessful = StorageImpl_ReadProperty(
+    readSuccessful = StorageImpl_ReadProperty(
                       This, 
                       currentPropertyIndex, 
                       &currentProperty);
     
-    if (readSucessful)
+    if (readSuccessful)
     {
       if ( (currentProperty.sizeOfNameString != 0 ) &&
            (currentProperty.propertyType     == PROPTYPE_ROOT) )
@@ -2191,9 +2191,9 @@ HRESULT StorageImpl_Construct(
 
     currentPropertyIndex++;
     
-  } while (readSucessful && (This->rootPropertySetIndex == PROPERTY_NULL) );
+  } while (readSuccessful && (This->rootPropertySetIndex == PROPERTY_NULL) );
   
-  if (!readSucessful)
+  if (!readSuccessful)
   {
     /* TODO CLEANUP */
     return E_FAIL;
@@ -2922,20 +2922,20 @@ BOOL StorageImpl_ReadProperty(
 {
   BYTE           currentProperty[PROPSET_BLOCK_SIZE];
   ULARGE_INTEGER offsetInPropSet;
-  BOOL         readSucessful;
+  BOOL         readSuccessful;
   ULONG          bytesRead;
 
   offsetInPropSet.s.HighPart = 0;
   offsetInPropSet.s.LowPart  = index * PROPSET_BLOCK_SIZE;
   
-  readSucessful = BlockChainStream_ReadAt(
+  readSuccessful = BlockChainStream_ReadAt(
                     This->rootBlockChain,
                     offsetInPropSet,
                     PROPSET_BLOCK_SIZE,
                     currentProperty,
                     &bytesRead);
   
-  if (readSucessful)
+  if (readSuccessful)
   {
     memset(buffer->name, 0, sizeof(buffer->name));
     memcpy(
@@ -3003,7 +3003,7 @@ BOOL StorageImpl_ReadProperty(
     buffer->size.s.HighPart = 0;
   }
 
-  return readSucessful;
+  return readSuccessful;
 }
 
 /*********************************************************************
@@ -3016,7 +3016,7 @@ BOOL StorageImpl_WriteProperty(
 {
   BYTE           currentProperty[PROPSET_BLOCK_SIZE];
   ULARGE_INTEGER offsetInPropSet;
-  BOOL         writeSucessful;
+  BOOL         writeSuccessful;
   ULONG          bytesWritten;
 
   offsetInPropSet.s.HighPart = 0;
@@ -3091,12 +3091,12 @@ BOOL StorageImpl_WriteProperty(
       OFFSET_PS_SIZE,         
       buffer->size.s.LowPart);
 
-  writeSucessful = BlockChainStream_WriteAt(This->rootBlockChain,
+  writeSuccessful = BlockChainStream_WriteAt(This->rootBlockChain,
                                             offsetInPropSet,
                                             PROPSET_BLOCK_SIZE,
                                             currentProperty,
                                             &bytesWritten);
-  return writeSucessful;
+  return writeSuccessful;
 }
 
 BOOL StorageImpl_ReadBigBlock(
@@ -3607,7 +3607,7 @@ HRESULT WINAPI IEnumSTATSTGImpl_Reset(
   IEnumSTATSTGImpl* const This=(IEnumSTATSTGImpl*)iface;
 
   StgProperty rootProperty;
-  BOOL      readSucessful;
+  BOOL      readSuccessful;
 
   /*
    * Re-initialize the search stack to an empty stack
@@ -3617,12 +3617,12 @@ HRESULT WINAPI IEnumSTATSTGImpl_Reset(
   /*
    * Read the root property from the storage.
    */
-  readSucessful = StorageImpl_ReadProperty(
+  readSuccessful = StorageImpl_ReadProperty(
                     This->parentStorage,
                     This->firstPropertyNode, 
                     &rootProperty);
 
-  if (readSucessful)
+  if (readSuccessful)
   {
     assert(rootProperty.sizeOfNameString!=0);
 
@@ -3793,7 +3793,7 @@ void IEnumSTATSTGImpl_PushSearchNode(
   ULONG             nodeToPush)
 {
   StgProperty rootProperty;
-  BOOL      readSucessful;
+  BOOL      readSuccessful;
 
   /*
    * First, make sure we're not trying to push an unexisting node.
@@ -3821,12 +3821,12 @@ void IEnumSTATSTGImpl_PushSearchNode(
   /*
    * Read the root property from the storage.
    */
-  readSucessful = StorageImpl_ReadProperty(
+  readSuccessful = StorageImpl_ReadProperty(
                     This->parentStorage,
                     nodeToPush, 
                     &rootProperty);
 
-  if (readSucessful)
+  if (readSuccessful)
   {
     assert(rootProperty.sizeOfNameString!=0);
 
@@ -3995,19 +3995,19 @@ void BlockChainStream_Destroy(BlockChainStream* This)
 ULONG BlockChainStream_GetHeadOfChain(BlockChainStream* This)
 {
   StgProperty chainProperty;
-  BOOL      readSucessful;
+  BOOL      readSuccessful;
 
   if (This->headOfStreamPlaceHolder != 0)
     return *(This->headOfStreamPlaceHolder);
 
   if (This->ownerPropertyIndex != PROPERTY_NULL)
   {
-    readSucessful = StorageImpl_ReadProperty(
+    readSuccessful = StorageImpl_ReadProperty(
                       This->parentStorage,
                       This->ownerPropertyIndex,
                       &chainProperty);
 
-    if (readSucessful)
+    if (readSuccessful)
     {
       return chainProperty.startingBlock;
     }
@@ -4516,16 +4516,16 @@ ULONG SmallBlockChainStream_GetHeadOfChain(
   SmallBlockChainStream* This)
 {
   StgProperty chainProperty;
-  BOOL      readSucessful;
+  BOOL      readSuccessful;
 
   if (This->ownerPropertyIndex)
   {
-    readSucessful = StorageImpl_ReadProperty(
+    readSuccessful = StorageImpl_ReadProperty(
                       This->parentStorage,
                       This->ownerPropertyIndex,
                       &chainProperty);
 
-    if (readSucessful)
+    if (readSuccessful)
     {
       return chainProperty.startingBlock;
     }

dlls/shell32/shlfolder.c

@@ -100,7 +100,7 @@ static HRESULT SHELL32_ParseNextElement(
 	LPITEMIDLIST	pidlOut, pidlTemp = NULL;
 	IShellFolder	*psfChild;
 	
-	TRACE("(%p, %p, %s)\n",psf, pidlInOut? *pidlInOut: "(null)", debugstr_w(szNext));
+	TRACE("(%p, %p, %s)\n",psf, pidlInOut ? *pidlInOut : NULL, debugstr_w(szNext));
 
 
 	/* get the shellfolder for the child pidl and let it analyse further */

documentation/no-windows

@@ -61,3 +61,6 @@ C:\windows is really /home/ego/wine/drives/c).
 - Put regedit.exe in the C:\windows directory (office95 imports
   a *.reg file when it runs with a empty registry, don't know
   about office97).
+
+- Also add winhelp.exe and winhlp32.exe if you want to be able to browse
+  through your programs' help function.

documentation/wine.man.in

@@ -93,6 +93,9 @@ file contained in the source distribution.
 .TP
 .I -backingstore
 Turn on backing store
+Backingstore stores pixels of obscured window parts off-screen.
+This buffer is used to restore these parts faster once they are to reappear,
+but it consumes additional memory of course.
 .TP
 .I -config filename
 Use the named configuration file rather than the default

graphics/d3dtexture.c

@@ -280,7 +280,7 @@ static HRESULT WINAPI IDirect3DTextureImpl_GetHandle(LPDIRECT3DTEXTURE iface,
     glGenTextures(1, &(This->tex_name));
   LEAVE_GL();
 
-  TRACE("OpenGL texture handle is : %ld\n", This->tex_name);
+  TRACE("OpenGL texture handle is : %d\n", This->tex_name);
   
   return D3D_OK;
 }
@@ -323,7 +323,7 @@ static HRESULT WINAPI IDirect3DTexture2Impl_GetHandle(LPDIRECT3DTEXTURE2 iface,
   glGenTextures(1, &(This->tex_name));
   LEAVE_GL();
 
-  TRACE("OpenGL texture handle is : %ld\n", This->tex_name);
+  TRACE("OpenGL texture handle is : %d\n", This->tex_name);
   
   return D3D_OK;
 }

if1632/snoop.c

@@ -7,6 +7,7 @@
 #include <assert.h>
 #include <string.h>
 #include "winbase.h"
+#include "winuser.h"
 #include "winnt.h"
 #include "heap.h"
 #include "global.h"

loader/loadorder.c

@@ -168,8 +168,8 @@ static BOOL ParseLoadOrder(char *order, module_loadorder_t *mlo)
 /***************************************************************************
  *	AddLoadOrder	(internal, static)
  *
- * Adds an entry in the list of overrides. If the entry exists then the
- * override parameter determines whether it will be overwriten.
+ * Adds an entry in the list of overrides. If the entry exists, then the
+ * override parameter determines whether it will be overwritten.
  */
 static BOOL AddLoadOrder(module_loadorder_t *plo, BOOL override)
 {
@@ -213,9 +213,9 @@ static BOOL AddLoadOrder(module_loadorder_t *plo, BOOL override)
 /***************************************************************************
  *	AddLoadOrderSet	(internal, static)
  *
- * Adds an set of entries in the list of overrides from the key parameter.
- * If the entry exists then the override parameter determines whether it
- * will be overwriten.
+ * Adds a set of entries in the list of overrides from the key parameter.
+ * If the entry exists, then the override parameter determines whether it
+ * will be overwritten.
  */
 static BOOL AddLoadOrderSet(char *key, char *order, BOOL override)
 {
@@ -300,7 +300,7 @@ endit:
  *	MODULE_InitLoadOrder	(internal)
  *
  * Initialize the load order from the wine.conf file.
- * The section has tyhe following format:
+ * The section has the following format:
  * Section:
  *	[DllDefaults]
  *
@@ -310,11 +310,11 @@ endit:
  * environment (see note in code below).
  *
  *	DefaultLoadOrder=native,elfdll,so,builtin
- * A comma seperated list of module-types to try to load in that specific
+ * A comma separated list of module types to try to load in that specific
  * order. The DefaultLoadOrder key is used as a fallback when a module is
- * not specified explicitely. If the DefaultLoadOrder key is not found, 
+ * not specified explicitly. If the DefaultLoadOrder key is not found, 
  * then the order "dll,elfdll,so,bi" is used
- * The possible module-types are:
+ * The possible module types are:
  *	- native	Native windows dll files
  *	- elfdll	Dlls encapsulated in .so libraries
  *	- so		Native .so libraries mapped to dlls
@@ -384,7 +384,7 @@ BOOL MODULE_InitLoadOrder(void)
 	nbuffer = PROFILE_GetWineIniString("DllDefaults", "DefaultLoadOrder", "n,e,s,b", buffer, sizeof(buffer));
 	if(!nbuffer)
 	{
-		MESSAGE("MODULE_InitLoadOrder: misteriously read nothing from default loadorder\n");
+		MESSAGE("MODULE_InitLoadOrder: mysteriously read nothing from default loadorder\n");
 		return FALSE;
 	}
 

loader/ne/module.c

@@ -837,12 +837,12 @@ static HINSTANCE16 NE_DoLoadModule( NE_MODULE *pModule )
     /* Allocate the segments for this module */
 
     if (!NE_CreateAllSegments( pModule ))
-        return 8;  /* Insufficient memory */
+        return ERROR_NOT_ENOUGH_MEMORY; /* 8 */
 
     /* Load the referenced DLLs */
 
     if (!NE_LoadDLLs( pModule ))
-        return 2;
+        return ERROR_FILE_NOT_FOUND; /* 2 */
 
     /* Load the segments */
 

loader/pe_image.c

@@ -509,7 +509,7 @@ HMODULE PE_LoadImage( HANDLE hFile, LPCSTR filename, WORD *version )
     /* Check signature */
     if ( nt->Signature != IMAGE_NT_SIGNATURE )
     {
-        WARN("%s image doesn't have PE signature, but 0x%08lx\n", nt->Signature );
+        WARN("%s image doesn't have PE signature, but 0x%08lx\n", filename, nt->Signature );
         goto error;
     }
 

scheduler/process.c

@@ -98,15 +98,15 @@ BOOL PROCESS_IsCurrent( HANDLE handle )
  *
  * Convert a process id to a PDB, making sure it is valid.
  */
-PDB *PROCESS_IdToPDB( DWORD id )
+PDB *PROCESS_IdToPDB( DWORD pid )
 {
     PDB *pdb;
 
-    if (!id) return PROCESS_Current();
+    if (!pid) return PROCESS_Current();
     pdb = PROCESS_First;
     while (pdb)
     {
-        if ((DWORD)pdb->server_pid == id) return pdb;
+        if ((DWORD)pdb->server_pid == pid) return pdb;
         pdb = pdb->next;
     }
     SetLastError( ERROR_INVALID_PARAMETER );

windows/x11drv/wnd.c

@@ -387,7 +387,7 @@ WND *X11DRV_WND_SetParent(WND *wndPtr, WND *pWndParent)
                 {
                     CREATESTRUCTA cs;
                     cs.lpCreateParams = NULL;
-                    cs.hInstance = 0; /* not used if following call */
+                    cs.hInstance = 0; /* not used in following call */
                     cs.hMenu = 0; /* not used in following call */
                     cs.hwndParent = pWndParent->hwndSelf;
                     cs.cy = wndPtr->rectWindow.bottom - wndPtr->rectWindow.top;