From 0698b918a4b826f2359967afb10449619137bef6 Mon Sep 17 00:00:00 2001 From: "Dimitrie O. Paun" Date: Mon, 22 Sep 2003 21:30:45 +0000 Subject: [PATCH] Remove redundant sections from the guide: tools: is now included in the new bin2res build: moved to PACKAGING cvs: is available in many other places. --- documentation/Makefile.in | 5 +- documentation/build.sgml | 192 -------------------- documentation/cvs.sgml | 331 ---------------------------------- documentation/tools.sgml | 94 ---------- documentation/wine-devel.sgml | 15 -- 5 files changed, 1 insertion(+), 636 deletions(-) delete mode 100644 documentation/build.sgml delete mode 100644 documentation/cvs.sgml delete mode 100644 documentation/tools.sgml diff --git a/documentation/Makefile.in b/documentation/Makefile.in index 770188dbee5..6c04962a994 100644 --- a/documentation/Makefile.in +++ b/documentation/Makefile.in @@ -24,10 +24,8 @@ WINE_USER_SRCS = \ WINE_DEVEL_SRCS = \ architecture.sgml \ - build.sgml \ consoles.sgml \ cvs-regression.sgml \ - cvs.sgml \ debugger.sgml \ debugging.sgml \ documentation.sgml \ @@ -38,8 +36,7 @@ WINE_DEVEL_SRCS = \ opengl.sgml \ patches.sgml \ porting.sgml \ - testing.sgml \ - tools.sgml + testing.sgml WINELIB_USER_SRCS = \ winelib-bindlls.sgml \ diff --git a/documentation/build.sgml b/documentation/build.sgml deleted file mode 100644 index c74c89ec0d9..00000000000 --- a/documentation/build.sgml +++ /dev/null @@ -1,192 +0,0 @@ - - Building Wine - - - Introduction - - - Written by &name-shachar-shemesh; &email-shachar-shemesh; - (Last updated: 5/27/2003) - - - (Extracted from wine/documentation/building) - - - This section explains how to build Wine locally. If you are a packager, please also refer to - wine/documentation/PACKAGING for package specific considerations. - - - - Before you compile - Soft vs. Hard dependencies - - - Wine is a compatibility layer. It is not an attempt to create a new OS. As such, it tries to - rely on existing functionality wherever possible. This means that some aspects of Wine require - libraries to be available during compilation and runtime, or certain functionality will not - be available. - - - - There are two types of dependencies. These are the soft dependency and the - hard dependency. - - - - Hard Dependency - - - This is a dependency of Wine that, if compiled into the code, must be available at runtime - or Wine will not function. Due to it's restrictive manner, developers go to a great length - to make sure there are as few of those as possible. - - - Fixme - - How many of those are there? - - - - - - Soft Dependency - - - These are libraries that, if present during both compilation and runtime, will add to Wine's - capabilities. Unlike the hard dependencies above, compiling Wine with these libraries will - allow Wine to work even on runtime environments where some or all of the soft dependencies - are not available. - - - Packager's note - - Please do your best to make sure that as many soft dependencies are available during - compilation. Failing to have a soft dependency available means that users cannot benefit - from a Wine capability. - - - - - - - - Soft dependencies list - - Here is a list of the libraries Wine needs, and their dependency is soft. We suggest packagers - install each and every last of those before building the package. These libraries are not - dependencies in the RPM sense. In DEB packages, they should appear as "Suggests" or "Recommends", - as the case may be. - - - - FreeType - - - This library is used for direct rendering of fonts. It provides better support of fonts than - using the X11 fonts engine. It is only needed for the X11 back end engine. Used from GDI. - - - - - Alsa - Linux only - - - This library gives sound support to the Windows environment. - - - - - libjack - - - Something to do with the MultiMedia system. Recording sound? - - Fixme - I don't truely know what this lib is. - - - - - CUPS - Common Unix Printing System - - - This library allows Windows to see CUPS defined printers, and to print to them. - - - - - OpenGL - - - This is used for both OpenGL and Direct3D (and some other DirectX functions as well) support - in Wine. There are many many libraries for providing this functionality. It is enough for one - of them to be available when compiling Wine. Wine can work with any other library during - runtime. - - - If no library is available, packagers are encouraged to compile Wine with - Mesa3D, which requires no hardware support to - install. - - - - - - - - - Getting the sources - - - HTTP Download - - The latest released sources - http://www.winehq.org/?page=download_source. - Installation instructions are also available at the same place. - - - - Getting sources from CVS - - In order to get the sources from CVS, you first need to log into the CVS server. Issue the - following command: - - -~/sources$ cvs -d :pserver:cvs@cvs.winehq.org:/home/wine login -Logging in to :pserver:cvs@cvs.winehq.org:2401/home/wine -CVS password: - - Use "cvs" as password. Next, you need to pull the sources from CVS. Use the - following command: - - -~/sources$ cvs -z 0 -d :pserver:cvs@cvs.winehq.org:/home/wine co wine -cvs checkout: Updating wine -U wine/.cvsignore -U wine/ANNOUNCE -U wine/AUTHORS -U wine/BUGS -U wine/COPYING.LIB - - The list will go on. When the operation finishes, a new directory called "wine" will be created, - and in it all the sources will reside. - - - Warning - - In the above example, compression was disabled. Versions of CVS up to, and including, 1.11.1 - hang if compression is enabled. If you have version 1.11.5 or higher, you can enable compression - by feeding other values to the -z argument. - - - - For more details, consult the HOWTO at http://www.winehq.org/?page=cvs - - - - - diff --git a/documentation/cvs.sgml b/documentation/cvs.sgml deleted file mode 100644 index b97cb365eb6..00000000000 --- a/documentation/cvs.sgml +++ /dev/null @@ -1,331 +0,0 @@ - - Using CVS - - - - What is CVS? - - - CVS (Concurrent - Versions System) is the leading source code control system in - the freeware community. It manages source code of projects, - keeps a history of changes to the source files and improves - conflict management when two or more developers work on the same - code part. Another major benefit of CVS is that it's very easy - to update a project to the latest version. CVS features - flexible branching, intelligent merging, high quality documentation - and client/server access with a wide choice of clients. - - - - Current Wine sources are available via anonymous client/server - CVS. You will need CVS 1.9 or above. If you are coming from - behind a firewall, you will either need a hole in the firewall - for the CVS port (2401) or use SOCKS. - - - - - CVS installation check - - First you need to make sure that you have cvs - installed. - To check whether this is the case, please run: - - - $ cvs - - - If this was successful, then you should have gotten a nice CVS - "Usage" help output. Otherwise (e.g. an error "cvs: command not - found") you still need to install a CVS package for your - particular operating system, similar to the instructions given - in the Wine User Guide chapters for getting and installing a - Wine package on various systems. - - - - - Configuring Wine-specific CVS settings - - - First, you should do a - - - $ touch ~/.cvspass - - - to create or update the file .cvspass in - your home directory, since CVS needs this file (for password - and login management) and will complain loudly if it doesn't exist. - - - - Second, we need to create the file - .cvsrc in your home directory - containing the CVS configuration settings needed for a valid - Wine CVS setup (use CVS compression, properly update file and - directory information, ...). - The content of this file should look like the following: - -cvs -z 3 -update -PAd -diff -u -checkout -P - - Create the file with an editor of your choice, either by running - - $ <editor> ~/.cvsrc - - , where <editor> is the editor you want to use (e.g. - joe, ae, - vi), - or by creating the file .cvsrc in your - home directory with your favorite graphical editor like nedit, kedit, - gedit or others. - - - -z sets the compression level (Levels higher - than 3 will probably not result in faster downloading unless you - have a fast machine and a slow network connection). - -Pd will delete empty directories and create - newly added ones. -A will reset any previous - tag in order to get the latest version in the tree. - -u will create the easiest to read - patches. Please do not submit patches with diff -w. - - - - - - Downloading the Wine CVS tree - - - Once CVS is installed and the Wine specific CVS - configuration is done, you can now do a login on our CVS - server and checkout (download) the Wine source code. - First, let's do the server login: - - - $ cvs -d :pserver:cvs@cvs.winehq.com:/home/wine login - - - If cvs successfully connects to the CVS server, - then you will get a "CVS password:" prompt. - Simply enter "cvs" as the password (the password is - case sensitive: no capital letters!). - If you want to use one of the mirror servers for Wine CVS - download, please refer to the section Wine CVS mirror servers. - - - - After login, we are able to download the Wine source code tree. - Please make sure that you are in the directory that you want - to have the Wine source code in (the Wine source code will - use the subdirectory wine/ in this - directory, since the subdirectory is named after the CVS module - that we want to check out). We assume that your current directory - might be your user's home directory. - To download the Wine tree into the subdirectory wine/, run: - - - $ cvs -d :pserver:cvs@cvs.winehq.com:/home/wine checkout wine - - - Downloading the CVS tree might take a while (some minutes - to few hours), depending on your connection speed. - Once the download is finished, you should keep a note of - which directory the newly downloaded - wine/ directory is in, by running - pwd (Print Working Directory): - - - $ pwd - - - Later, you will be able to change to this directory by - running: - - - $ cd <some_dir> - - - , where <some_dir> is the directory that - pwd gave you. - By running - - - $ cd wine - - - , you can now change to the directory of the Wine CVS tree - you just downloaded. - - - - - Wine CVS mirror servers - - - Wine's CVS tree is mirrored at several places around the world - to make sure that the source is easily accessible. Note that not - all servers have all repositories available, but all have at - least the Wine source. - - - CVS access is granted through CVS' "pserver" - authentication. You should set - your CVSROOT environment variable to point to one of - the servers using this format: - - -CVSROOT=:pserver:<Username>@<CVS Server>:<Server root> - - - Alternatively, you can use the -d parameter of - cvs instead. - Substitute the applicable fields from the table below. - - - Just do a traceroute and a ping on all servers below to find out - which are - closest to you. - - - Wine CVS servers - - - - CVS Server - Username - Password - - - - - cvs.winehq.com; Minnesota, USA (CodeWeavers) - cvs - cvs - - - -
- - - - - Other modules available via CVS from WineHQ - - - The WineHQ CVS server makes a couple of other things available as well. - To get these, log in anonymously as above and do: - - - $ cvs co <modulename> - - - where <modulename> is one of: - - - - - Winehq_com -- source for the WineHQ web site - - - - - c2man -- automatic documentation system, specially modified for Wine - - - - - - - Converting a Wine FTP download to a CVS tree - - - Getting the entire Wine source tree via - CVS is pretty slow, especially compared to getting Wine from an - FTP mirror near you. It's possible to convert a Wine tarball to a CVS - sandbox, just like you would get by checking out the entire source - via CVS. Here's how to do it: - - - - - Get the latest Wine snapshot: Wine-YYMMDD.tar.gz - - - - - Get wine-cvsdirs-YYMMDD.tar.gz from ftp://ftp.winehq.com/pub/wine - - - Use an FTP client rather than a web browser, and be sure to turn off passive mode, otherwise the fetch will hang. - - - e.g.: - - -ftp ftp.winehq.com -cd pub/wine -passive off -ls - - - - - Untar them on top of each other: - - -tar xzf Wine-YYYYMMDD.tar.gz -mv wine-YYYYMMDD wine -tar xzf wine-cvsdirs-YYYYMMDD.tar.gz - - - - - Update from main tree: login as above, then do - - -cd wine -cvs update -PAd - - - - - You will now be completely up to date. - - - - - WineHQ cvsweb access - - -Direct access to the complete CVS tree is also possible, using Bill Fenner's -cvsweb package: - - - - cvs.winehq.com/cvsweb, on the primary CVS repository - - - - - - - - - diff --git a/documentation/tools.sgml b/documentation/tools.sgml deleted file mode 100644 index 21ad6eca8e3..00000000000 --- a/documentation/tools.sgml +++ /dev/null @@ -1,94 +0,0 @@ - - Tools - - - bin2res - - - Written by &name-juergen-schmied; &email-juergen-schmied; (11/99) - - - (Extracted from wine/documentation/resources) - - - - This document describes tools for handling resources within wine - - - - bin2res - - - This tool allows the editing of embedded binary resources - within *.rc files. These resources are - stored as hex dump so they can be stored within the cvs - tree. This makes the editing of the embedded bitmaps and - icons harder. - - - - - Create binary files from an <filename>.rc</filename> file - - - The resources in the .rc file have to - be marked by a header: - - -/* BINRES idb_std_small.bmp */ -IDB_STD_SMALL BITMAP LOADONCALL DISCARDABLE -{ - '42 4D 20 07 00 00 00 00 00 00 76 00 00 00 28 00' - - - BINRES is the keyword followed by a - filename. bin2res -d bin rsrc.rc - generates binary files from all marked resources. If the - binary file is newer it gets not overwritten. To force - overwriting use the -f switch. - - - - - Create a <filename>.rc</filename> file from binaries - - - Put a header followed by empty brackets in the - .rc file. - - -/* BINRES idb_std_small.bmp */ -{} - - - Then run bin2res rsrc.rc. It will merge - the resources into the .rc file if the - binary resources are newer than the.rc file. To force the - resources into the .rc file use the - -f switch. If there is already a - resource with the same filename in the - .rc file it gets overwritten. - - - - - output of <command>bin2res</command> - - -bash-2.03# ../../tools/bin2res -d bin shres.rc -[000.ico:c][003.ico:c][008.ico:s][015.ico:s][034.ico:s] - - - s means skipped, c - means changed. - - - - - - diff --git a/documentation/wine-devel.sgml b/documentation/wine-devel.sgml index 1edbcd2053d..e39c873ad79 100644 --- a/documentation/wine-devel.sgml +++ b/documentation/wine-devel.sgml @@ -1,16 +1,10 @@ - -%authors; - - - @@ -18,8 +12,6 @@ - - @@ -112,13 +104,11 @@ Developing Wine - &build; &debugger; &documentation; &patches; &testing; &i18n; - &tools; @@ -132,11 +122,6 @@ - Using CVS - &cvs; - - - Advanced Topics &implementation; &porting;