Browse Source

Documentation update, plus cvs docs

svn path=/trunk/mono/; revision=338
Miguel de Icaza 24 years ago
parent
commit
5a8d2bbd2c
8 changed files with 202 additions and 10 deletions
  1. 9 2
      doc/contributing
  2. 91 0
      doc/cvs
  3. 0 2
      doc/download
  4. 1 1
      doc/ideas
  5. 9 2
      web/contributing
  6. 91 0
      web/cvs
  7. 0 2
      web/download
  8. 1 1
      web/ideas

+ 9 - 2
doc/contributing

@@ -18,6 +18,15 @@
 	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

+ 91 - 0
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=:[email protected]:/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 [email protected] < 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 [email protected].
+	To subscribe, send an email message to
+	[email protected] 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).
+
+

+ 0 - 2
doc/download

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

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

+ 9 - 2
web/contributing

@@ -18,6 +18,15 @@
 	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

+ 91 - 0
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=:[email protected]:/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 [email protected] < 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 [email protected].
+	To subscribe, send an email message to
+	[email protected] 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).
+
+

+ 0 - 2
web/download

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

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