Bladeren bron

Updates to the web site, documentation

svn path=/trunk/mono/; revision=2047
Miguel de Icaza 24 jaren geleden
bovenliggende
commit
ab7465ea46
12 gewijzigde bestanden met toevoegingen van 106 en 20 verwijderingen
  1. 25 0
      doc/c-sharp
  2. 0 1
      doc/class-status
  3. 9 0
      doc/ideas
  4. 0 1
      doc/pending-classes.in
  5. 8 7
      doc/runtime
  6. 11 1
      doc/testing
  7. 25 0
      web/c-sharp
  8. 0 1
      web/class-status
  9. 9 0
      web/ideas
  10. 0 1
      web/pending-classes.in
  11. 8 7
      web/runtime
  12. 11 1
      web/testing

+ 25 - 0
doc/c-sharp

@@ -15,6 +15,31 @@
 	the compiler and various programs are routinely compiled and
 	ran.
 
+** Obtaining MCS
+
+	The Mono C# compiler is part of the `mcs' module in the Mono CVS
+	you can get it from our <a href="anoncvs.html">Anonymous CVS</a> server,
+	or you can get nightly <a href="download.html">download page</a>.
+
+** Running MCS
+
+	MCS is written in C# and uses heavily the .NET APIs.  At this point
+	MCS only runs on Windows with the .NET Framework SDK installed.  Work
+	is progressing rapidly in our JIT engine and our class libraries to
+	allow MCS to be ran in non-Windows systems. 
+
+** Reporting Bugs in MCS
+
+	When you report a bug, try to provide a small test case that would
+	show the error so we can include this as part of the Mono C# regression
+	test suite.
+
+	If the bug is an error or a warning that we do not flag, write
+	a sample program called `csXXXX.cs' where XXXX is the code number
+	that is used by the Microsoft C# compiler that illustrates the 
+	problem.  That way we can also do regression tests on the invalid
+	input.  
+
 ** Phases of the compiler
 
 	The compiler has a number of phases:

+ 0 - 1
doc/class-status

@@ -54,7 +54,6 @@ This is a list of pending classes, and links to their documentation on MSDN.Micr
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemGlobalizationTextElementEnumeratorClassTopic.asp">System.Globalization.TextElementEnumerator</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemGlobalizationTextInfoClassTopic.asp">System.Globalization.TextInfo</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemGlobalizationThaiBuddhistCalendarClassTopic.asp">System.Globalization.ThaiBuddhistCalendar</a><br>
-	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOBufferedStreamClassTopic.asp">System.IO.BufferedStream</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOEndOfStreamExceptionClassTopic.asp">System.IO.EndOfStreamException</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOIsolatedStorageIsolatedStorageClassTopic.asp">System.IO.IsolatedStorage.IsolatedStorage</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOIsolatedStorageIsolatedStorageExceptionClassTopic.asp">System.IO.IsolatedStorage.IsolatedStorageException</a><br>

+ 9 - 0
doc/ideas

@@ -1,5 +1,14 @@
 * Ideas
 
+	There are many pending classes that need to be implemented.  Those have
+	the highest impact in the Mono project: the sooner they are done,
+	the sooner we can start using this platform to create new and
+	exciting applications.
+
+	That being said, if you are not very excited about working on class
+	libraries, here is a list of other related projects or tools that might
+	be useful to the Mono project.
+
 	Here are a few ideas of tools, classes and projects that you
 	could start. More are forthcoming.
 

+ 0 - 1
doc/pending-classes.in

@@ -31,7 +31,6 @@ System.Globalization.TaiwanCalendar
 System.Globalization.TextElementEnumerator
 System.Globalization.TextInfo
 System.Globalization.ThaiBuddhistCalendar
-System.IO.BufferedStream
 System.IO.EndOfStreamException
 System.IO.IsolatedStorage.IsolatedStorage
 System.IO.IsolatedStorage.IsolatedStorageException

+ 8 - 7
doc/runtime

@@ -1,18 +1,19 @@
 * The Mono runtime
 
-	The Mono runtime will implement the JIT engine (and a byte
-	code interpreter for quickly porting to new systems), the
-	class loader, the garbage collector, threading system and
-	metadata access libraries.
+	The Mono runtime implements a JIT engine for the CIL virtual
+	machine (as well as a byte code interpreter, this is to
+	quickly port it to new systems), the class loader, the garbage
+	collector, threading system and metadata access libraries.
 
 	We currently have two runtimes:
 
 	<ul>
+		* <b>mono:</b> The Just In Time compiler implemented
+	 	  using a BURS instruction selector.  We only support
+		  x86 machines in the JIT engine at this point.
+	
 		* <b>mint:</b> The Mono interpreter.  This is an
 		  easy-to-port runtime engine.
-
-		* <b>mono:</b> The Just In Time compiler implemented
-	 	  using a BURS instruction selector
 	</ul>
 
 	Currently both runtimes are missing garbage collection.  We

+ 11 - 1
doc/testing

@@ -1,4 +1,12 @@
-* Testing 
+* Testing
+
+	Testing is an important part of the Mono project: every one of its
+	three major components has a test suite tailored for its needs.  This
+	is very helpful, because in the course of developing the software it
+	is very common to introduce bugs in existing code.  A test suite
+	helps us fix the bugs as soon as they are introduced.
+
+** Class Library Tests
 
 	All classes in Mono libraries should have comprehensive unit test
 	suites to go with them. Unit testing is a software engineering
@@ -19,3 +27,5 @@
 	more info, read <a
 	href="http://nunit.sourceforge.net/doc/testinfected/testing.html">
 	JUnit Test Infected: Programmers Love Writing Tests</a>.
+
+

+ 25 - 0
web/c-sharp

@@ -15,6 +15,31 @@
 	the compiler and various programs are routinely compiled and
 	ran.
 
+** Obtaining MCS
+
+	The Mono C# compiler is part of the `mcs' module in the Mono CVS
+	you can get it from our <a href="anoncvs.html">Anonymous CVS</a> server,
+	or you can get nightly <a href="download.html">download page</a>.
+
+** Running MCS
+
+	MCS is written in C# and uses heavily the .NET APIs.  At this point
+	MCS only runs on Windows with the .NET Framework SDK installed.  Work
+	is progressing rapidly in our JIT engine and our class libraries to
+	allow MCS to be ran in non-Windows systems. 
+
+** Reporting Bugs in MCS
+
+	When you report a bug, try to provide a small test case that would
+	show the error so we can include this as part of the Mono C# regression
+	test suite.
+
+	If the bug is an error or a warning that we do not flag, write
+	a sample program called `csXXXX.cs' where XXXX is the code number
+	that is used by the Microsoft C# compiler that illustrates the 
+	problem.  That way we can also do regression tests on the invalid
+	input.  
+
 ** Phases of the compiler
 
 	The compiler has a number of phases:

+ 0 - 1
web/class-status

@@ -54,7 +54,6 @@ This is a list of pending classes, and links to their documentation on MSDN.Micr
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemGlobalizationTextElementEnumeratorClassTopic.asp">System.Globalization.TextElementEnumerator</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemGlobalizationTextInfoClassTopic.asp">System.Globalization.TextInfo</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemGlobalizationThaiBuddhistCalendarClassTopic.asp">System.Globalization.ThaiBuddhistCalendar</a><br>
-	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOBufferedStreamClassTopic.asp">System.IO.BufferedStream</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOEndOfStreamExceptionClassTopic.asp">System.IO.EndOfStreamException</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOIsolatedStorageIsolatedStorageClassTopic.asp">System.IO.IsolatedStorage.IsolatedStorage</a><br>
 	<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemIOIsolatedStorageIsolatedStorageExceptionClassTopic.asp">System.IO.IsolatedStorage.IsolatedStorageException</a><br>

+ 9 - 0
web/ideas

@@ -1,5 +1,14 @@
 * Ideas
 
+	There are many pending classes that need to be implemented.  Those have
+	the highest impact in the Mono project: the sooner they are done,
+	the sooner we can start using this platform to create new and
+	exciting applications.
+
+	That being said, if you are not very excited about working on class
+	libraries, here is a list of other related projects or tools that might
+	be useful to the Mono project.
+
 	Here are a few ideas of tools, classes and projects that you
 	could start. More are forthcoming.
 

+ 0 - 1
web/pending-classes.in

@@ -31,7 +31,6 @@ System.Globalization.TaiwanCalendar
 System.Globalization.TextElementEnumerator
 System.Globalization.TextInfo
 System.Globalization.ThaiBuddhistCalendar
-System.IO.BufferedStream
 System.IO.EndOfStreamException
 System.IO.IsolatedStorage.IsolatedStorage
 System.IO.IsolatedStorage.IsolatedStorageException

+ 8 - 7
web/runtime

@@ -1,18 +1,19 @@
 * The Mono runtime
 
-	The Mono runtime will implement the JIT engine (and a byte
-	code interpreter for quickly porting to new systems), the
-	class loader, the garbage collector, threading system and
-	metadata access libraries.
+	The Mono runtime implements a JIT engine for the CIL virtual
+	machine (as well as a byte code interpreter, this is to
+	quickly port it to new systems), the class loader, the garbage
+	collector, threading system and metadata access libraries.
 
 	We currently have two runtimes:
 
 	<ul>
+		* <b>mono:</b> The Just In Time compiler implemented
+	 	  using a BURS instruction selector.  We only support
+		  x86 machines in the JIT engine at this point.
+	
 		* <b>mint:</b> The Mono interpreter.  This is an
 		  easy-to-port runtime engine.
-
-		* <b>mono:</b> The Just In Time compiler implemented
-	 	  using a BURS instruction selector
 	</ul>
 
 	Currently both runtimes are missing garbage collection.  We

+ 11 - 1
web/testing

@@ -1,4 +1,12 @@
-* Testing 
+* Testing
+
+	Testing is an important part of the Mono project: every one of its
+	three major components has a test suite tailored for its needs.  This
+	is very helpful, because in the course of developing the software it
+	is very common to introduce bugs in existing code.  A test suite
+	helps us fix the bugs as soon as they are introduced.
+
+** Class Library Tests
 
 	All classes in Mono libraries should have comprehensive unit test
 	suites to go with them. Unit testing is a software engineering
@@ -19,3 +27,5 @@
 	more info, read <a
 	href="http://nunit.sourceforge.net/doc/testinfected/testing.html">
 	JUnit Test Infected: Programmers Love Writing Tests</a>.
+
+