man/mdoc-update.1

   1 .\"
   2 .\" mdoc-update manual page.
   3 .\" (C) 2008 Jonathan Pryor
   4 .\" Author:
   5 .\"   Jonathan Pryor (jpryor@novell.com)
   6 .\"
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .TH "mdoc-update" 1
  12 .SH NAME
  13 mdoc update \- \fBmdoc\fR(5) documentation format support
  14 .SH SYNOPSIS
  15 \fBmdoc update\fR [OPTIONS]* ASSEMBLIES
  16 .SH DESCRIPTION
  17 \fBmdoc update\fR is responsible for the following:
  18 .TP
  19 .B *
  20 Creating documentation stubs based on \fIASSEMBLIES\fR.  The stub-creation
  21 process will create new \fBmdoc\fR(5) XML files for each type within
  22 \fIASSEMBLIES\fR, and provide documentation stubs for each member of those
  23 types.
  24 .TP
  25 .B *
  26 Update documentation stubs based on \fIASSEMBLIES\fR.  Existing \fBmdoc\fR(5)
  27 documentation can be updated to reflect changes within \fIASSEMBLIES\fR, such
  28 as added types and members, while preserving existing documentation.
  29 .Sp
  30 In some limited circumstances, renames will be tracked, minimizing the
  31 documentation burden when e.g. a parameter is renamed.
  32 circumstances,
  33 creates stubs and updates documentation in the \fBmdoc\fR(5)
  34 documentation format from \fIASSEMBLIES\fR.
  35 .PP
  36 \fBmdoc update\fR does not rely on documentation found within source code.
  37 .PP
  38 See \fBmdoc\fR(1) and \fBmdoc\fR(5) for more information.
  39 .SH OPTIONS
  40 .TP
  41 .B \-\-delete
  42 Allow \fBmdoc update\fR to delete members from documentation files.
  43 The only members deleted are members which are no longer present within
  44 \fIASSEMBLIES\fR and are not present in any other assembly versions.
  45 .Sp
  46 If a type is no longer present, the documentation file is \fInot\fR
  47 deleted, but is instead \fIrenamed\fR to have a \fB.remove \fR extension.
  48 .Sp
  49 Version detection is done with the \fI//AssemblyVersion\fR elements; if there
  50 are no \fI//AssemblyVersion\fR elements for a given \fI<Type>\fR or
  51 \fI<Member/>\fR, then the \fI<Type>\fR will be renamed and/or the
  52 \fI<Member/>\fR will be removed.
  53 .TP
  54 \fB\-i\fR, \fB\-\-import\fR=\fIFILE\fR
  55 Import documentation found within \fIFILE\fR.
  56 .Sp
  57 \fIFILE\fR may contain either \fIcsc /doc\fR XML or \fIECMA-335\fR XML.
  58 .TP
  59 \fB\-o\fR, \fB\-\-out\fB=\fIDIRECTORY\fR
  60 Place the generated stubs into \fIDIRECTORY\fR.
  61 .Sp
  62 When updating documentation, \fIDIRECTORY\fR is also the source directory.
  63 .B \-h, \-?, \-\-help
  64 Display a help message and exit.
  65 .SH SEE ALSO
  66 mdoc(1),
  67 mdoc(5),
  68 mdoc-assemble(1),
  69 mdoc-export-html(1),
  70 mdoc-validate(1),
  71 .SH MAILING LISTS
  72 .TP
  73 Visit http://lists.ximian.com/mailman/listinfo/mono-docs-list for details.
  74 .SH WEB SITE
  75 Visit http://www.mono-project.com for details