Permalink
Browse files

* mdoc-update.1: Document -L, -r options.

svn path=/trunk/mono/; revision=131449
  • Loading branch information...
1 parent e6e5024 commit 6166db125b24d7e617c733297dca893ffa425059 Jonathan Pryor committed Apr 10, 2009
Showing with 17 additions and 4 deletions.
  1. +4 −0 man/ChangeLog
  2. +13 −4 man/mdoc-update.1
View
@@ -1,3 +1,7 @@
+2009-04-09 Jonathan Pryor <jpryor@novell.com>
+
+ * mdoc-update.1: Document -L, -r options.
+
2009-04-06 Jonathan Pryor <jpryor@novell.com>
* mdoc.5: Document //code/@src attribute.
View
@@ -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.
-circumstances,
-creates stubs and updates documentation in the \fBmdoc\fR(5)
-documentation format from \fIASSEMBLIES\fR.
.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
@@ -177,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
+\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
+\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

0 comments on commit 6166db1

Please sign in to comment.