Documentation update, plus cvs docs
authorMiguel de Icaza <miguel@gnome.org>
Sat, 28 Jul 2001 17:45:16 +0000 (17:45 -0000)
committerMiguel de Icaza <miguel@gnome.org>
Sat, 28 Jul 2001 17:45:16 +0000 (17:45 -0000)
svn path=/trunk/mono/; revision=338

doc/contributing
doc/cvs [new file with mode: 0644]
doc/download
doc/ideas
web/contributing
web/cvs [new file with mode: 0644]
web/download
web/ideas

index 7e64a96ab21ec8d76975b01c5c5dc297eda225f1..8601078c37988fc478332b8baf58f59416bcac2c 100644 (file)
        something that would help tremendously would be to help with
        small duties in the project that need to be addressed. 
 
+** Bug reporting
+
+       If you find bugs in Mono, please make sure you enter a bug
+       report so we can keep track of problems in Mono.
+
+       To enter bug reports go to <a href="http://bugzilla.ximian.com">
+       http://bugzilla.ximian.com</a> and enter bug reports against
+       your favorite component (Mono, Runtime, C# compiler).
+
 ** Small tasks
 
        A few smaller tasks are here, dropped in no particular order:
@@ -29,8 +38,6 @@
 
                * <b>Mono/doc and web site:</b> They need to be
                  packaged up in the official `distribution'
-
-               * <b>Enthusiasts: </b>
        </ul>
 
 * Special note
diff --git a/doc/cvs b/doc/cvs
new file mode 100644 (file)
index 0000000..cbd57f6
--- /dev/null
+++ b/doc/cvs
@@ -0,0 +1,91 @@
+* CVS Access
+
+       If you are an active Mono developer, you can get a CVS account
+       that hosts the Mono source code.
+
+       Send an e-mail to miguel with your public SSH key for this purpose.
+
+       You will need CVS and SSH.  Windows users can get both by
+       installing Cygwin (<a
+       href="http://www.cygwin.org">http://www.cygwin.org</a>)
+
+       Unix users will probably have those tools installed already.
+
+** Checking out the sources
+
+       The first time you checkout the sources, you will have to
+       "login" to the CVS.  To do this, type from a shell session (in
+       Windows, double click on the Cygwin icon, on Unix, that is
+       your default shell)
+
+<pre>
+       export CVS_RSH=ssh
+       export CVS_ROOT=:username@mono-cvs.ximian.com:/cvs/public
+       cvs login
+       cvs -z3 co mcs mono
+</pre>
+
+** Updating your sources
+
+       Every day people will be making changes, to get your latest
+       updated sources, use:
+
+<pre>
+       cvs -z3 update mcs mono
+</pre>
+
+** Making patches
+
+       Usually you will want to make a patch to contribute, and let
+       other people review it before commiting it.  To obtain such a
+       "patch", you type:
+       
+<pre>
+       cd directory-you-want-to-diff
+       cvs -z3 diff -u > file.diff
+       mail mono-list@ximian.com < file.diff
+</pre>
+
+** Commiting your work
+
+       Once you get approval to commit to the CVS, or if you are
+       commiting code that you are the maintainer of, you will want
+       to commit your code to CVS. 
+
+       To do this, you have to "add" any new files that you created:
+
+<pre>
+       cvs add new-file.c
+</pre>
+
+       And then commit your changes to the repository:
+
+<pre>
+       cvs commit .
+</pre>
+
+** The Mailing List
+
+       To keep track of the various development and changes to the
+       CVS tree, you can subscribe to the mono-cvs-list@ximian.com.
+       To subscribe, send an email message to
+       mono-cvs-list-request@ximian.com and in the body of the
+       message put `subscribe'.
+
+       This will send you an email message every time a change is
+       made to the CVS repository, together with the information that
+       the author of the changes submitted.
+       
+** Recommendations
+
+       Please do not commit code that would break the compile to the
+       CVS, because that normally wastes everybody's time.  
+
+       Make sure that you add all the files before you do a commit.
+
+       Use ChangeLog entries so we can keep textual descriptions of
+       your work, and use the contents of your ChangeLog file as the
+       CVS commit message (ie, paste the contents of this into the
+       editor buffer).
+
+
index 24d20c2601f9a34b57b914d6f4fe1024b75d48e4..7a3d6512c753c0200170d0a03ed5f18467a4f26e 100644 (file)
@@ -59,7 +59,6 @@ href="ftp://ftp.gtk.org/pub/gtk/v1.2/glib-1.2.10.tar.gz">ftp://ftp.gtk.org/pub/g
                <a name="july-14">
                <b>July 14th, 2001</b>
                <ul>
-               * <a href="archive/jay.cs.tar.gz">archive/jay.cs.tar.gz</a>: Sources to Jay.
                * <a href="archive/mcs-12-Jul-2001.tar.gz">mcs-12-Jul-2001.tar.gz</a>: CVS snapshot.
                * <a href="archive/mono-0.3.tar.gz">mono-0.3.tar.gz</a>: Packaged Source Code.
                </ul>
@@ -68,7 +67,6 @@ href="ftp://ftp.gtk.org/pub/gtk/v1.2/glib-1.2.10.tar.gz">ftp://ftp.gtk.org/pub/g
                <b>July 8th, 2001</b>
 
                <ul>
-               * <a href="archive/jay.cs.tar.gz">archive/jay.cs.tar.gz</a>: Sources.
                * <a href="archive/mcs-08-Jul-2001.tar.gz">mcs-08-Jul-2001.tar.gz</a>: CVS Snapshot
                * <a href="archive/mono-08-Jul-2001.tar.gz">mono-08-Jul-2001.tar.gz</a>: CVS Snapshot
                </ul>
index 2664dfad1e214b44c6360e30b161ec8b140097e5..fb2a89aa205fa8a41311b253a7b2045fc8404bea 100644 (file)
--- a/doc/ideas
+++ b/doc/ideas
@@ -44,7 +44,7 @@ TODO=multimedia
 
 TODO=gtk,Gtk+ wrappers for Mono and .NET
                * Wrap the Gtk+ API.  This is simple and can be done
-                 on Windows as Gtk+ 1.3 works on Windows.
+                 on Windows as Gtk+ 2.0 works on Windows.
 
                  This work can also be used on Windows and will
                  enable developers on Windows to use some of Gtk+'s
index 7e64a96ab21ec8d76975b01c5c5dc297eda225f1..8601078c37988fc478332b8baf58f59416bcac2c 100644 (file)
        something that would help tremendously would be to help with
        small duties in the project that need to be addressed. 
 
+** Bug reporting
+
+       If you find bugs in Mono, please make sure you enter a bug
+       report so we can keep track of problems in Mono.
+
+       To enter bug reports go to <a href="http://bugzilla.ximian.com">
+       http://bugzilla.ximian.com</a> and enter bug reports against
+       your favorite component (Mono, Runtime, C# compiler).
+
 ** Small tasks
 
        A few smaller tasks are here, dropped in no particular order:
@@ -29,8 +38,6 @@
 
                * <b>Mono/doc and web site:</b> They need to be
                  packaged up in the official `distribution'
-
-               * <b>Enthusiasts: </b>
        </ul>
 
 * Special note
diff --git a/web/cvs b/web/cvs
new file mode 100644 (file)
index 0000000..cbd57f6
--- /dev/null
+++ b/web/cvs
@@ -0,0 +1,91 @@
+* CVS Access
+
+       If you are an active Mono developer, you can get a CVS account
+       that hosts the Mono source code.
+
+       Send an e-mail to miguel with your public SSH key for this purpose.
+
+       You will need CVS and SSH.  Windows users can get both by
+       installing Cygwin (<a
+       href="http://www.cygwin.org">http://www.cygwin.org</a>)
+
+       Unix users will probably have those tools installed already.
+
+** Checking out the sources
+
+       The first time you checkout the sources, you will have to
+       "login" to the CVS.  To do this, type from a shell session (in
+       Windows, double click on the Cygwin icon, on Unix, that is
+       your default shell)
+
+<pre>
+       export CVS_RSH=ssh
+       export CVS_ROOT=:username@mono-cvs.ximian.com:/cvs/public
+       cvs login
+       cvs -z3 co mcs mono
+</pre>
+
+** Updating your sources
+
+       Every day people will be making changes, to get your latest
+       updated sources, use:
+
+<pre>
+       cvs -z3 update mcs mono
+</pre>
+
+** Making patches
+
+       Usually you will want to make a patch to contribute, and let
+       other people review it before commiting it.  To obtain such a
+       "patch", you type:
+       
+<pre>
+       cd directory-you-want-to-diff
+       cvs -z3 diff -u > file.diff
+       mail mono-list@ximian.com < file.diff
+</pre>
+
+** Commiting your work
+
+       Once you get approval to commit to the CVS, or if you are
+       commiting code that you are the maintainer of, you will want
+       to commit your code to CVS. 
+
+       To do this, you have to "add" any new files that you created:
+
+<pre>
+       cvs add new-file.c
+</pre>
+
+       And then commit your changes to the repository:
+
+<pre>
+       cvs commit .
+</pre>
+
+** The Mailing List
+
+       To keep track of the various development and changes to the
+       CVS tree, you can subscribe to the mono-cvs-list@ximian.com.
+       To subscribe, send an email message to
+       mono-cvs-list-request@ximian.com and in the body of the
+       message put `subscribe'.
+
+       This will send you an email message every time a change is
+       made to the CVS repository, together with the information that
+       the author of the changes submitted.
+       
+** Recommendations
+
+       Please do not commit code that would break the compile to the
+       CVS, because that normally wastes everybody's time.  
+
+       Make sure that you add all the files before you do a commit.
+
+       Use ChangeLog entries so we can keep textual descriptions of
+       your work, and use the contents of your ChangeLog file as the
+       CVS commit message (ie, paste the contents of this into the
+       editor buffer).
+
+
index 24d20c2601f9a34b57b914d6f4fe1024b75d48e4..7a3d6512c753c0200170d0a03ed5f18467a4f26e 100644 (file)
@@ -59,7 +59,6 @@ href="ftp://ftp.gtk.org/pub/gtk/v1.2/glib-1.2.10.tar.gz">ftp://ftp.gtk.org/pub/g
                <a name="july-14">
                <b>July 14th, 2001</b>
                <ul>
-               * <a href="archive/jay.cs.tar.gz">archive/jay.cs.tar.gz</a>: Sources to Jay.
                * <a href="archive/mcs-12-Jul-2001.tar.gz">mcs-12-Jul-2001.tar.gz</a>: CVS snapshot.
                * <a href="archive/mono-0.3.tar.gz">mono-0.3.tar.gz</a>: Packaged Source Code.
                </ul>
@@ -68,7 +67,6 @@ href="ftp://ftp.gtk.org/pub/gtk/v1.2/glib-1.2.10.tar.gz">ftp://ftp.gtk.org/pub/g
                <b>July 8th, 2001</b>
 
                <ul>
-               * <a href="archive/jay.cs.tar.gz">archive/jay.cs.tar.gz</a>: Sources.
                * <a href="archive/mcs-08-Jul-2001.tar.gz">mcs-08-Jul-2001.tar.gz</a>: CVS Snapshot
                * <a href="archive/mono-08-Jul-2001.tar.gz">mono-08-Jul-2001.tar.gz</a>: CVS Snapshot
                </ul>
index 2664dfad1e214b44c6360e30b161ec8b140097e5..fb2a89aa205fa8a41311b253a7b2045fc8404bea 100644 (file)
--- a/web/ideas
+++ b/web/ideas
@@ -44,7 +44,7 @@ TODO=multimedia
 
 TODO=gtk,Gtk+ wrappers for Mono and .NET
                * Wrap the Gtk+ API.  This is simple and can be done
-                 on Windows as Gtk+ 1.3 works on Windows.
+                 on Windows as Gtk+ 2.0 works on Windows.
 
                  This work can also be used on Windows and will
                  enable developers on Windows to use some of Gtk+'s