[31857] trunk/doc-new/guide/xml/portfileref.xml

[Ryan Schmidt]

On Dec 10, 2007, at 05:50, ryandesign at macports.org wrote:

> Modified: trunk/doc-new/guide/xml/portfileref.xml
> ===================================================================
> --- trunk/doc-new/guide/xml/portfileref.xml	2007-12-10 08:52:25 UTC  
> (rev 31856)
> +++ trunk/doc-new/guide/xml/portfileref.xml	2007-12-10 11:50:36 UTC  
> (rev 31857)
> @@ -322,10 +322,10 @@
>              <variablelist>
>                <varlistentry>
>                  <term>eval xinstall [-o owner] [-g group] [-m  
> mode] [glob
> -                regexp] directory</term>
> +                pattern] directory</term>
>
>                  <listitem>
> -                  <para>Install the file(s) matching the glob  
> expression to a
> +                  <para>Install the file(s) matching the glob  
> pattern to a
>                    destination directory.</para>
>                  </listitem>
>                </varlistentry>


There needs to be a way in the guide to indicate which parts should  
be typed verbatim and which are placeholders which should be  
replaced. Manpages, for example, use bold for things to be typed  
verbatim, and underline for things to be replaced.

Someone reading the above might think that "glob pattern" should be  
replaced with the glob pattern, when in fact "glob" is the function  
name and should be typed verbatim while "pattern" is to be replaced  
with the pattern.