Merge pull request #4248 from Unity-Technologies/boehm-gc-alloc-fixed

[mono.git] / man / mdoc-update.1

diff --git a/man/mdoc-update.1 b/man/mdoc-update.1
index 0ae9654ea2b707df035b2c5fd325fed61bc064b3..d05091922195be609bc87cfa9b480e6341c83f90 100644 (file)
--- a/man/mdoc-update.1
+++ b/man/mdoc-update.1
@@ -29,11 +29,9 @@ as added types and members, while preserving existing documentation.
 .Sp
 In some limited circumstances, renames will be tracked, minimizing the
 documentation burden when e.g. a parameter is renamed.
 .Sp
 In some limited circumstances, renames will be tracked, minimizing the
 documentation burden when e.g. a parameter is renamed.

-circumstances, 
-creates stubs and updates documentation in the \fBmdoc\fR(5)
-documentation format from \fIASSEMBLIES\fR.

 .PP
 .PP

-\fBmdoc update\fR does not rely on documentation found within source code.
+\fBmdoc update\fR does not rely on documentation found within source code,
+though it can import XML Documentation Comments via the \fB\-i\fR option.

 .PP
 See \fBmdoc\fR(1) and \fBmdoc\fR(5) for more information.
 .SH OPTIONS
 .PP
 See \fBmdoc\fR(1) and \fBmdoc\fR(5) for more information.
 .SH OPTIONS


@@ -62,6 +60,12 @@ member.
 that should be searched for exceptions:
 .Sp
 .nf
 that should be searched for exceptions:
 .Sp
 .nf

+        added   Only generate <exception/> elements for members 
+                  added during the current program execution.
+                  This keeps mdoc-update from re-generating
+                  <exception/> elements for all members (and thus
+                  prevents re-insertion for members that had the
+                  <exception/> elements removed).

         all     Find exceptions created in the member itself, 
                   references to members in the same assembly, 
                   and references to members in dependent 
         all     Find exceptions created in the member itself, 
                   references to members in the same assembly, 
                   and references to members in dependent 


@@ -171,11 +175,22 @@ Import documentation found within \fIFILE\fR.
 .Sp
 \fIFILE\fR may contain either \fIcsc /doc\fR XML or \fIECMA-335\fR XML.
 .TP
 .Sp
 \fIFILE\fR may contain either \fIcsc /doc\fR XML or \fIECMA-335\fR XML.
 .TP

-\fB\-o\fR, \fB\-\-out\fB=\fIDIRECTORY\fR
+\fB\-L\fR, \fB\-\-lib\fR=\fIDIRECTORY\fR
+Add \fIDIRECTORY\fR to the assembly search path, so that dependencies of
+\fIASSEMBLIES\fR can be found without documenting those assemblies.
+.TP
+\fB\-o\fR, \fB\-\-out\fR=\fIDIRECTORY\fR

 Place the generated stubs into \fIDIRECTORY\fR.
 .Sp
 When updating documentation, \fIDIRECTORY\fR is also the source directory.
 .TP
 Place the generated stubs into \fIDIRECTORY\fR.
 .Sp
 When updating documentation, \fIDIRECTORY\fR is also the source directory.
 .TP

+\fB\-r\fR=\fIASSEMBLY\fR
+\fIASSEMBLY\fR is a dependency for one of \fIASSEMBLIES\fR which should
+\fInot\fR be documented but is required to process one of \fIASSEMBLIES\fR.
+Add the directory containing \fIASSEMBLY\fR to the assembly search path.
+.Sp
+This option is equivalent to specifying \fB\-L\fR `\fIdirname\fR ASSEMBLY`.
+.TP

 \fB\-\-since\fR=\fIVERSION\fR
 When \fIupdating\fR documentation for an assembly, if a type or member is
 encountered which didn't exist in the previous version of the assembly a
 \fB\-\-since\fR=\fIVERSION\fR
 When \fIupdating\fR documentation for an assembly, if a type or member is
 encountered which didn't exist in the previous version of the assembly a