From 6166db125b24d7e617c733297dca893ffa425059 Mon Sep 17 00:00:00 2001 From: Jonathan Pryor Date: Fri, 10 Apr 2009 02:06:01 +0000 Subject: [PATCH] * mdoc-update.1: Document -L, -r options. svn path=/trunk/mono/; revision=131449 --- man/ChangeLog | 4 ++++ man/mdoc-update.1 | 17 +++++++++++++---- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/man/ChangeLog b/man/ChangeLog index 73999bd25ee..16561f1a193 100644 --- a/man/ChangeLog +++ b/man/ChangeLog @@ -1,3 +1,7 @@ +2009-04-09 Jonathan Pryor + + * mdoc-update.1: Document -L, -r options. + 2009-04-06 Jonathan Pryor * mdoc.5: Document //code/@src attribute. diff --git a/man/mdoc-update.1 b/man/mdoc-update.1 index a9666d93f4e..d0509192219 100644 --- 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. -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 -- 2.25.1