Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

Runtime documentation will now build with srcdir != builddir

This removes an old and broken patch that did not allow for
clean builds of Mono.   The old patch was so bad, that instead
of fixing the actual source of the problem (the ability to build
the runtime documentation when the source directory was not the
same as the build directory), a hack was added to circumvent
`make distcheck''s security system and changed the permissions
at build time for the source directory to become read/write.

This fixes the problem
latest commit e3150746f3
Miguel de Icaza migueldeicaza authored April 16, 2014
..
Octocat-spinner-32 HtmlAgilityPack EOL handling July 25, 2010
Octocat-spinner-32 deploy Create .gitignore's. February 28, 2009
Octocat-spinner-32 sources [monkeydoc] Merge/add monkeydoc to master. November 23, 2012
Octocat-spinner-32 svgs The drawings for the /Compacting_GC page June 05, 2006
Octocat-spinner-32 .gitignore Add a few .gitignore entries to reduce noise July 28, 2010
Octocat-spinner-32 ChangeLog * docs/Makefile.am: fix distcheck - several targets get built on the April 06, 2010
Octocat-spinner-32 Makefile.am Runtime documentation will now build with srcdir != builddir April 16, 2014
Octocat-spinner-32 README Switch from using HtmlAgilityPack 1.0 binary snapshot to HtmlAgilityP… December 22, 2009
Octocat-spinner-32 TODO * Makefile.am: Build `docs` after `runtime`, so that it can depend October 31, 2008
Octocat-spinner-32 abc-removal.txt Make docs consistent April 21, 2007
Octocat-spinner-32 api-style.css * Makefile.am: Build `docs` after `runtime`, so that it can depend October 31, 2008
Octocat-spinner-32 assembly-bundle Formatting changes January 31, 2004
Octocat-spinner-32 check-coverage * Makefile.am: Build `docs` after `runtime`, so that it can depend October 31, 2008
Octocat-spinner-32 check-exports * check, Makefile.am (EXTRA_DIST): Rename to check-exports. This was October 31, 2008
Octocat-spinner-32 convert.cs * Makefile.am: Build `docs` after `runtime`, so that it can depend October 31, 2008
Octocat-spinner-32 current-api Add mono_gc_wbarrier_generic_store_atomic () function. October 21, 2013
Octocat-spinner-32 docs.make Runtime documentation will now build with srcdir != builddir April 16, 2014
Octocat-spinner-32 documented Remove methods that are private from the documentation May 11, 2010
Octocat-spinner-32 embedded-api Add notice June 05, 2006
Octocat-spinner-32 exceptions Formatting changes January 31, 2004
Octocat-spinner-32 exdoc Runtime documentation will now build with srcdir != builddir April 16, 2014
Octocat-spinner-32 file-share-modes File share mode notes May 21, 2004
Octocat-spinner-32 gc-issues Added the docs dir to the dist (with a new doc on GC issues). March 29, 2002
Octocat-spinner-32 gc-variables-in-c Precise GC doc updates. May 30, 2006
Octocat-spinner-32 glossary.txt Add June 24, 2007
Octocat-spinner-32 historic-mono-branches.txt Add a list of historic Mono branches, before we delete them from the … August 04, 2011
Octocat-spinner-32 ignore Update documentation to latest changes, need to document a lot of mis… May 11, 2010
Octocat-spinner-32 internal-calls Documentation updates. September 25, 2006
Octocat-spinner-32 ir-desc Doc update September 06, 2004
Octocat-spinner-32 jit-imt Primarily, add support for mono_arch_get_throw_corlib_exception and IMT March 23, 2010
Octocat-spinner-32 jit-thoughts *** empty log message *** May 11, 2002
Octocat-spinner-32 jit-trampolines Update August 19, 2008
Octocat-spinner-32 local-regalloc.txt New compilation engine for Mono April 05, 2003
Octocat-spinner-32 magic.diff magic file(1) patch. March 24, 2006
Octocat-spinner-32 mini-doc.txt Update docs May 26, 2010
Octocat-spinner-32 mono-api-metadata.html * Makefile.am: Build `docs` after `runtime`, so that it can depend October 31, 2008
Octocat-spinner-32 mono-file-formats.config * docs.make, Makefile.am: Build mono-file-formats{.tree,.zip}, November 19, 2008
Octocat-spinner-32 mono-file-formats.source * mono-file-formats.source, mono-tools.source: Place these under the December 08, 2008
Octocat-spinner-32 mono-tools.config remove monostyle manpage November 10, 2009
Octocat-spinner-32 mono-tools.source * mono-file-formats.source, mono-tools.source: Place these under the December 08, 2008
Octocat-spinner-32 mono_handle_d 2002-07-10 Dennis Haney <davh@davh.dk> July 10, 2002
Octocat-spinner-32 monoapi.source * Makefile.am: Build `docs` after `runtime`, so that it can depend October 31, 2008
Octocat-spinner-32 new-regalloc New regalloc design. July 09, 2004
Octocat-spinner-32 object-layout documentation updates March 15, 2002
Octocat-spinner-32 opcode-decomp.txt New compilation engine for Mono April 05, 2003
Octocat-spinner-32 precise-gc Precise GC doc updates. May 30, 2006
Octocat-spinner-32 produce-lists Remove methods that are private from the documentation May 11, 2010
Octocat-spinner-32 public * Makefile.am: Build `docs` after `runtime`, so that it can depend October 31, 2008
Octocat-spinner-32 public-api Add mono_gc_wbarrier_generic_store_atomic () function. October 21, 2013
Octocat-spinner-32 reactive-extension-bundle.txt import Microsoft Reactive Extensions from rx.codeplex.com and add to … November 15, 2012
Octocat-spinner-32 release-notes-1.0.html Start May 30, 2004
Octocat-spinner-32 remoting Added information about the cross-app domain optimizations in the rem… November 10, 2004
Octocat-spinner-32 ssapre.txt Corrected word spelling August 10, 2011
Octocat-spinner-32 stack-alignment *** empty log message *** March 18, 2002
Octocat-spinner-32 stack-overflow.txt Add September 12, 2007
Octocat-spinner-32 threading Thread doc March 07, 2003
Octocat-spinner-32 toc.xml [runtime/docs] Update toc December 20, 2012
Octocat-spinner-32 tree-mover.txt 2006-03-31 Massimiliano Mantione <massi@ximian.com> March 31, 2006
Octocat-spinner-32 unmanaged-calls documentation updates March 15, 2002
Octocat-spinner-32 wapi Update documentation to latest changes, need to document a lot of mis… May 11, 2010
README
Documentation is now maintained on the mono wiki:

http://www.mono-project.com/Mono:Runtime:Documentation

Older documents or documents which were not yet migrated to the wiki are kept here.

* Scripts to maintain the Mono VM internal API

Layout
------

	sources/
		mono-api-*.html

		Contains the various source files, each source file
		contains HTML, and a line for each API call like this:

		<h4><a name="api:mono_something">mono_something</a></h4>

		The format is static, notice that the tools actually search
		for the above format and process that (both the tools here, 
	  	as well as the upcoming Monodoc tools and index creation
		tools).

		The files can contain any ammount of extra information.

		The documentation from the source code is then merged with 
		these files and the header/footer information to produce
		the deploy directory.

	deploy/

		Scripts produce a ready-to-use set of XHTML files that can
		be either fed into a monodoc XHTML provider or can be published
		directly on the web.

PROGRAMS
--------
* check-coverage

	Run this script every once in a while to make sure that a
	public symbol that has been added to Mono has a corresponding
	section on the mono-vm-api.html

	This works by looking for the <h4>APICALL</h4> pattern on the
	HTML file.
	
* produce-lists

	Produces the public-api and wapi files that contain the public
	libmono API.

* exdoc

	Extracts the embedded documentation from the sources.

* check

	This script is used to verify which routines are missing inline
	documentation, usage:

		check mono/metadata/*.c

* convert.cs

	Converts an HTML file into a valid XML document, uses the
	AgilityPack.dll.  The sources to this DLL live in the 
        HtmlAgilityPack folder, and are a prerequisite for convert.exe.

DATAFILES:
---------

	ignore

		Contains the list of public symbols that should be
		ignored, they come from tests for example, or are known
		to be exposed.

		This is consumed by produce-lists
	
	public-api 
	wapi
		These two are produced by the produce-lists script
		and it documents all the public methods.

Something went wrong with that request. Please try again.