Re: [AD] docs updates

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


On 2007-01-20, Milan Mimica <milan.mimica@xxxxxxxxxx> wrote:
> 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.

It should be "CVS, Subversion, etc" :-)

> Index: docs/src/build/msvc._tx
> ===================================================================
> --- docs/src/build/msvc._tx	(revision 7694)
> +++ docs/src/build/msvc._tx	(working copy)
...
> @@ -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>").

I would phrase that as:

    run <tt>misc\embedman.bat all</tt> from the command prompt

> 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

SVN in caps.

>  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:

Ditto.

>  <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

<tt>svn diff</tt>

>  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.

check the Subversion manual for

(I think "Subversion" should be preferred over "SVN" in most cases,
unlike with CVS.)

> 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

Don't change this.

>     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.

Change that to "4.2.1 (SVN)".

The rest looks fine.

Peter





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