[AD] docs updates

[ Thread Index | Date Index | More lists.liballeg.org/allegro-developers Archives ]


The attached patch includes corrections proposed by Evert to the MSVC build docs. I also did a search & replace for CVS -> SVN thought the docs. I think I left the "CVS" where appropriate, grep for it.
Please check that everything is fine.

I would also note that the Online patch creation at http://www.allegro.cc/dev/make-diff.php doesn't work. Probably because it tries to connect to CVS, instead of SVN.


--
Milan Mimica
http://sparklet.sf.net
Index: docs/src/thanks._tx
===================================================================
--- docs/src/thanks._tx	(revision 7694)
+++ docs/src/thanks._tx	(working copy)
@@ -1186,7 +1186,7 @@
 
    Sourceforge.net (<link>http://sourceforge.net/</a>).<br>
    The Allegro community has been using their services (web, mailing lists,
-   cvs, etc) since 3.9.x WIP versions.
+   svn, etc) since 3.9.x WIP versions.
 
    Tom Grandgent (<email>tgrand@xxxxxxxxxx</a>).<br>
    Organised and hosted the original Allegro mailing lists for many years.
Index: docs/src/abi._tx
===================================================================
--- docs/src/abi._tx	(revision 7694)
+++ docs/src/abi._tx	(working copy)
@@ -56,7 +56,7 @@
 Windows notes
 
    If you don't need a modified version of Allegro then just link your
-   program against an officially blessed non-WIP, non-CVS, non-dodgy
+   program against an officially blessed non-WIP, non-SVN, non-dodgy
    version. Don't disable any features (eg. colour depths, drivers) in
    the DLL.
 
Index: docs/src/build/mingw32._tx
===================================================================
--- docs/src/build/mingw32._tx	(revision 7694)
+++ docs/src/build/mingw32._tx	(working copy)
@@ -185,7 +185,7 @@
 <blockquote>
    1. Make sure you have a working Cygwin installation. You can download the
       <tt>setup.exe</tt> program from '<link>http://sources.redhat.com/cygwin/</a>'.
-      You will need the followin packages: bash, binutils, cygwin, cygutils,
+      You will need the following packages: bash, binutils, cygwin, cygutils,
       fileutils, gcc, gdb, login, make, man, mingw-runtime, sed, sh-utils,
       texinfo, textutils and w32api.
 
@@ -279,7 +279,7 @@
 <endblock>
    4. Run '<tt>./fix.sh mingw --dtou</tt>' (<tt>--dtou</tt> is only needed if your Allegro
       directory has text files in DOS format, otherwise you can use <tt>--quick</tt>).
-      If you are using a CVS version of Allegro, run '<tt>make depend</tt>' to
+      If you are using a SVN version of Allegro, run '<tt>make depend</tt>' to
       generate the build dependencies, then run '<tt>misc/fixdll.sh</tt>' to generate
       the <tt>allegro.def</tt> file. You are now finished with all the preparations.
 
@@ -368,7 +368,7 @@
    To activate any of these, type (for example) "<tt>make WARNMODE=1</tt>".
 
    If your copy of Allegro does not include the linker .def file (unlikely,
-   unless you have run "<tt>make veryclean</tt>" at some point, or are using the CVS
+   unless you have run "<tt>make veryclean</tt>" at some point, or are using the SVN
    version of Allegro), you can regenerate it by running "<tt>misc\fixdll.bat</tt>".
    You will need to have GNU sed and sort installed for this operation to
    work. The version of sed that is linked from the MinGW site does not
Index: docs/src/build/qnx._tx
===================================================================
--- docs/src/build/qnx._tx	(revision 7694)
+++ docs/src/build/qnx._tx	(working copy)
@@ -49,7 +49,7 @@
       ./fix.sh qnx
 <endblock>
    Now you may want to generate the dependencies; this step is optional if
-   you are using an official release, but it is required if you got a CVS
+   you are using an official release, but it is required if you got a SVN
    snapshot of the library.
 <textblock>
       make depend
Index: docs/src/build/msvc._tx
===================================================================
--- docs/src/build/msvc._tx	(revision 7694)
+++ docs/src/build/msvc._tx	(working copy)
@@ -93,29 +93,28 @@
    This is a source-only distribution, so you will have to compile Allegro 
    before you can use it. To do this you should:
 
-@domain.hid Setting up environment
+@hnode Setting up the environment
 
    Set up your environment so that MSVC can be used from the commandline.
    You probably have a <tt>vcvars32.bat</tt> file that will do this for you
-   (exact location of this file depends on your MSVC version and folder where
-   you have MSVC installed, e.g. for MSVC 6 it is usually 
+   (the exact location of this file depends on your MSVC version and folder
+   where you have MSVC installed, e.g. for MSVC 6 it is usually 
    <tt>C:\Program Files\Microsoft Visual Studio\VC98\Bin</tt>, for MSVC 8 
-   <tt>C:\Program Files\Microsoft Visual Studio 8\VC\Bin</tt> and the like).
+   <tt>C:\Program Files\Microsoft Visual Studio 8\VC\Bin</tt> etc.).
    You will have to run this file every time you open a DOS box or configure 
    the environment variables in Control Panel/System/Environment (autoexec.bat
    for Win 9x/ME). 
 
 @hnode Configuring Allegro
 
-   In the command line window type type "<tt>fix.bat msvc</tt>" to configure
-   Allegro for MSVC.
+   To configure Allegro for your compiler please run in the command prompt:
+<textblock>
+       fix.bat msvc6  - for MSVC 6 and older
+       fix.bat msvc7  - for MSVC 7 (.NET) and 7.1 (.NET 2003)
+       fix.bat msvc8  - for MSVC 8 (.NET 2005)
+       fix.bat icl    - for Intel compiler
+<endblock>
 
-   If you are using MSVC 7 you can specify "<tt>msvc7</tt>" instead of "<tt>msvc</tt>" to enable
-   better optimizations. Likewise, you can specify "<tt>icl</tt>" to use the Intel
-   commandline compiler. If you are using MSVC 8 you should specify "<tt>msvc8</tt>"
-   otherwise you will get a lot of deprecation warnings. For MSVC 6 and older
-   you can use also "<tt>msvc6</tt>".
-
 @hnode Long paths handling
 
    Normally you can skip this section, unless you have some problem with
@@ -124,30 +123,30 @@
    The make process needs all the path variables to be in DOS 8.3 format, and
    since MSVC is usually installed in something like
    "<tt>C:\Program Files\Microsoft\Microsoft Visual Studio .NET 2003</tt>",
-   this may cause a problem. The <tt>fix.bat</tt> normally handles this for you so
-   you should not need to care about this. However you can run
-   "<tt>echo %MSVCDir%</tt>" (<tt>%VCINSTALLDIR%</tt> under MSVC 8)
+   this may cause a problem. This should normally be handled by
+   <tt>fix.bat</tt>, so you probably don't need to worry about this. However you
+   can run "<tt>echo %MSVCDir%</tt>" (<tt>%VCINSTALLDIR%</tt> under MSVC 8)
    from the command line to see if it contain spaces.
    If you are using MSVC 6 or lower the output should already be in DOS 8.3
    format so you should not have any troubles. With higher versions of MSVC
-   it will probably show the long path with spaces. The <tt>fix.bat</tt>
-   will automatically try to convert it to DOS 8.3 format. You can disable
-   this conversion by passing <tt>--nomsvcpaths</tt> parameter to <tt>fix.bat</tt>
+   it will probably show the long path with spaces. Normally, <tt>fix.bat</tt>
+   will try to convert it to DOS 8.3 format automatically. You can disable this
+   conversion by passing the <tt>--nomsvcpaths</tt> parameter to <tt>fix.bat</tt>
    (note that this conversion is automatically disabled when using "<tt>msvc6</tt>").
 
-   If you want to handle this by yourself manually, you will have to
-   edit <tt>vcvars32.bat</tt> so that it sets the 8.3 paths, not the long versions.
+   If you want to handle this yourself manually, you will have to edit
+   <tt>vcvars32.bat</tt> so that it sets the 8.3 paths, not the long versions.
    To get 8.3 path names, you can use the command prompt (<tt>cmd.exe</tt>).
    Type in "<tt>dir /x</tt>" to get a listing of the 8.3 file and directory
    names alongside of their full names. You can also use the DOS prompt
    (<tt>command.exe</tt>) and "<tt>dir</tt>", but this will only show
    you the 8.3 names.
 
-@domain.hid Building from CVS
+@hnode Building from SVN
 
-   If you are compiling from CVS, before continuing you must run both
-   "<tt>make depend</tt>" and "<tt>misc/fixdll.sh</tt>" as explained below, or the build will
-   fail asking for some <tt>.inc</tt> file.
+   If you are compiling from SVN, you need to run "<tt>make depend</tt>" and
+   "<tt>misc/fixdll.sh</tt>" before continuing as explained below, or the
+   library will fail to build because of missing <tt>.inc</tt> files.
 
 @hnode Building Allegro
 
@@ -163,9 +162,9 @@
    When it finishes compiling, type "<tt>make install</tt>" to set the library up
    ready for use.
 
-   If you are using MSVC 8  and want to embed manifest files to executables
-   (by default is embedded just into the DLL), run from command prompt
-   "<tt>misc\embedman.bat all</tt>" ("<tt>./misc/embedman.bat all</tt>" under Cygwin).
+   If you are using MSVC 8 and want to embed manifest files to executables
+   (by default manifests are just embedded in the DLL), run from command prompt
+   "<tt>misc\embedman.bat all</tt>" (Cygwin users run "<tt>misc/embedman.bat all</tt>").
 
    If you also want to install a debugging version of the library (highly 
    recommended), now type "<tt>make install DEBUGMODE=1</tt>". Case is important, so
@@ -179,11 +178,11 @@
 
    If your copy of Allegro doesn't include the <tt>makefile.dep</tt> dependency files
    (unlikely, unless you have run "<tt>make veryclean</tt>" at some point or are
-   building the CVS version), you can regenerate them by running
+   building the SVN version), you can regenerate them by running
    "<tt>make depend</tt>".
 
    If your copy of Allegro doesn't include the linker .def file (unlikely, 
-   unless you have run "<tt>make veryclean</tt>" at some point or are building the CVS
+   unless you have run "<tt>make veryclean</tt>" at some point or are building the SVN
    version), you can regenerate it by running "<tt>misc\fixdll.bat</tt>". Cygwin users
    can run "<tt>misc/fixdll.sh</tt>" instead.
 
Index: docs/src/build/macosx._tx
===================================================================
--- docs/src/build/macosx._tx	(revision 7694)
+++ docs/src/build/macosx._tx	(working copy)
@@ -58,7 +58,7 @@
       chmod +x fix.sh
       ./fix.sh macosx
 <endblock>
-   If you have checked out a development version from Allegro's CVS
+   If you have checked out a development version from Allegro's SVN
    repository, run the following command. Otherwise, skip this step:
 <textblock>
       make depend
Index: docs/src/build/unix._tx
===================================================================
--- docs/src/build/unix._tx	(revision 7694)
+++ docs/src/build/unix._tx	(working copy)
@@ -103,7 +103,7 @@
    Alternatively, you can add the path to your <tt>LD_LIBRARY_PATH</tt> environment
    variable.
 
-   If you are compiling a CVS version of Allegro, you need to generate the
+   If you are compiling a SVN version of Allegro, you need to generate the
    configure header and script prior to doing anything else. Make sure that
    GNU autoconf 2.53 or newer is installed on your system and type:
 <textblock>
Index: docs/src/build/djgpp._tx
===================================================================
--- docs/src/build/djgpp._tx	(revision 7694)
+++ docs/src/build/djgpp._tx	(working copy)
@@ -53,9 +53,9 @@
 
 
 @heading
-Allegro CVS Notes
+Allegro SVN Notes
 
-   If you are using a CVS version of Allegro, then you will need to do some
+   If you are using a SVN version of Allegro, then you will need to do some
    extra things to ensure that your copy of Allegro will compile correctly.
    These are covered in detail below, but briefly:
 <blockquote>
@@ -118,12 +118,12 @@
    files and HTML format documentation).
 
    If your copy of Allegro is set up for use with some different compiler 
-   (if you downloaded a tar.gz archive or a CVS version), you will have to 
+   (if you downloaded a tar.gz archive or a SVN version), you will have to 
    run '<tt>fix.bat djgpp</tt>' before compiling it. If you are using bash you can run
    '<tt>fix.sh djgpp</tt>' instead.
 
    If your copy of Allegro doesn't include the makefile.dep dependency files 
-   (if you have run "<tt>make veryclean</tt>" or you have the CVS version), you can 
+   (if you have run "<tt>make veryclean</tt>" or you have the SVN version), you can 
    regenerate them by running "<tt>make depend</tt>".
 
    If `<tt>make</tt>' tells you that you need to download a new package, or if you
Index: docs/src/ahack._tx
===================================================================
--- docs/src/ahack._tx	(revision 7694)
+++ docs/src/ahack._tx	(working copy)
@@ -566,26 +566,26 @@
 
 
 
-@domain.hid Building your patch against a CVS version
+@hnode Building your patch against a SVN version
 
-If you are working with the cvs version of Allegro which you can get from
+If you are working with the svn version of Allegro which you can get from
 Sourceforge (<link>http://sourceforge.net/projects/alleg/</a>), you won't need
 to copy any files at all. Just modify the files you want, go to the root
-directory of the cvs copy and type:
+directory of the svn copy and type:
 <textblock>
-   cvs diff -u > patch
+   svn diff > patch
 <endblock>
-Unlike the standalone diff, the cvs diff command will work recursively
+Unlike the standalone diff, the svn diff command will work recursively
 through the Allegro source tree, comparing each file against the Sourceforge
 repository. The patch will have slightly different headers, but that's ok,
 once you have it follow the previous process to send it to the developers
-mailing list. Of course, check cvs' manual for more information and options.
+mailing list. Of course, check svn's manual for more information and options.
 
 
 
 @hnode Online patch creation
 
-Sometimes you don't have the diff tool around, or don't have the cvs tool to
+Sometimes you don't have the diff tool around, or don't have the svn tool to
 check out the bleeding edge version of Allegro, or you are too lazy to care
 how to actually make the patch yourself. For any of those cases, you can use
 the online Allegro patcher at <link>http://www.allegro.cc/dev/make-diff.php</a>.
Index: docs/src/changes._tx
===================================================================
--- docs/src/changes._tx	(revision 7694)
+++ docs/src/changes._tx	(working copy)
@@ -3329,7 +3329,7 @@
    desktop_color_depth(); yield_timeslice();
 <li>
    3.9.34: Peter Wang retroactively updated CHANGES and AUTHORS from
-   late 3.9.33 to present using CVS logs and email archives, and
+   late 3.9.33 to present using SVN logs and email archives, and
    possibly messed up.
 <li>
    3.9.34: Angelo Mottola added a BeOS windowed driver (originally by
Index: docs/src/allegro._tx
===================================================================
--- docs/src/allegro._tx	(revision 7694)
+++ docs/src/allegro._tx	(working copy)
@@ -209,8 +209,8 @@
 @@#define @ALLEGRO_VERSION_STR
 @shortdesc Defined to a string with the full Allegro version number.
    Defined to a text string containing all version numbers and maybe some
-   additional text. This could be `4.1.16 (CVS)' for an Allegro version
-   obtained straight from the CVS repository.
+   additional text. This could be `4.1.16 (SVN)' for an Allegro version
+   obtained straight from the SVN repository.
    
 @@#define @ALLEGRO_DATE_STR
 @shortdesc Defined to a string with the year Allegro was released.
@@ -16100,11 +16100,11 @@
 stepped forward to continue improving Allegro. Transformed into a meritocratic
 community, users keep sending bug reports to the mailing lists, developers
 around the world keep sending patches to fix them, and a few carefully chosen
-have write access to the CVS repository, from which releases are built every
+have write access to the SVN repository, from which releases are built every
 now and then.
 
 But, who decides when a build is stable enough? Who decides when somebody is
-granted write access to the CVS? Who chooses the lesser of two evils patching
+granted write access to the SVN? Who chooses the lesser of two evils patching
 some obscure bug? And more importantly, who decides what's Allegro's mascot?
 For all these reasons, the community decided to replace Shawn's position with
 the Allegro Dictator.
Index: misc/fixver.sh
===================================================================
--- misc/fixver.sh	(revision 7694)
+++ misc/fixver.sh	(working copy)
@@ -6,7 +6,7 @@
 #
 #  Note: if you pass "datestamp" as the only argument, then the version
 #  digits will remain unchanged and the comment will be set to the date.
-#  This is in particular useful for making CVS snapshots.
+#  This is in particular useful for making SVN snapshots.
 
 
 if [ $# -lt 3 -o $# -gt 4 ]; then
Index: misc/zipup.sh
===================================================================
--- misc/zipup.sh	(revision 7694)
+++ misc/zipup.sh	(working copy)
@@ -12,7 +12,7 @@
 #
 #  Note: if you write datestamp in the archive_name field, then the
 #  resulting archive will be datestamped. This is in particular useful
-#  for making CVS snapshots.
+#  for making SVN snapshots.
 
 
 if [ $# -lt 1 -o $# -gt 2 ]; then
@@ -45,7 +45,7 @@
    rm _tmpfile
 done
 
-# fix some wrong permissions in the CVS repository
+# fix some wrong permissions in the SVN repository
 chmod +x misc/asmdef.sh misc/fixdll.sh
 
 


Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/