VirtualBox

Changeset 36952 in vbox for trunk/doc


Ignore:
Timestamp:
May 4, 2011 9:43:48 AM (14 years ago)
Author:
vboxsync
Message:

doc/UserManual+SDKRef: fix broken crossrefs, and make sure that from now on broken crossrefs cause failure

Location:
trunk/doc/manual
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Makefile.kmk

    r36033 r36952  
    55
    66#
    7 # Copyright (C) 2006-2007 Oracle Corporation
     7# Copyright (C) 2006-2011 Oracle Corporation
    88#
    99# This file is part of VirtualBox Open Source Edition (OSE), as
    … …  
    509509                  $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$f/,$(VBOX_MANUAL_PNG_FILES_$(f)))) | $$(dir $$@)
    510510# PDF generation via Latex: generate the .tex file
    511         $(call MSG_L1,pdflatex $< (three passes) -> $@)
     511        $(call MSG_L1,pdflatex $< (four passes) -> $@)
    512512        $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
    513513        $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
    514514        $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
    515515        $(QUIET)$(REDIRECT) -w+ti /dev/null -C $(@D) -- $(PDFLATEX) UserManual.tex
     516        $(QUIET)$(SED) -n \
     517        -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
     518        $(basename $@).log
     519
    516520##@todo restore this when above has been converted to INSTALLS target.  $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
    517521
    … …  
    554558        $(QUIET)$(REDIRECT) -C $(<D) -- $(PDFLATEX) SDKRef.tex
    555559        $(QUIET)$(REDIRECT) -C $(<D) -- $(PDFLATEX) SDKRef.tex
     560        $(QUIET)$(SED) -n \
     561        -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
     562        $(basename $<).log
    556563        $(QUIET)$(CP) $(<D)/SDKRef.pdf $@
    557564        $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)

  • trunk/doc/manual/en_US/SDKRef.xml

    r36457 r36952  
    17461746
    17471747          <para>As a real-world example of a method invocation, let's call
    1748           <xref linkend="IVirtualBox__openRemoteSession"
    1749           xreflabel="IVirtualBox::openRemoteSession" /> which returns an
     1748          <xref linkend="IMachine__launchVMProcess"
     1749          xreflabel="IMachine::launchVMProcess" /> which returns an
    17501750          IProgress object. Note again that the method name is
    17511751          capitalized.</para>
    … …  
    17531753          <screen>IProgress *progress;
    17541754...
    1755 rc = vbox-&gt;vtbl-&gt;OpenRemoteSession(
    1756     vbox,          /* this  */
     1755rc = vbox-&gt;vtbl-&gt;LaunchVMProcess(
     1756    machine,       /* this  */
    17571757    session,       /* arg 1 */
    1758     id,            /* arg 2 */
    1759     sessionType,   /* arg 3 */
    1760     env,           /* arg 4 */
     1758    sessionType,   /* arg 2 */
     1759    env,           /* arg 3 */
    17611760    &amp;progress      /* Out   */
    17621761);
    … …  
    34513450          <para>This version introduces the guest facilities concept. A guest
    34523451          facility either represents a module or feature the guest is running or
    3453           offering, which is defined by <xref linked="AdditionsFacilityType"
     3452          offering, which is defined by <xref linkend="AdditionsFacilityType"
    34543453          xreflabel="AdditionsFacilityType"/>. Each facility is member of a
    3455           <xref linked="AdditionsFacilityClass" xreflabel="AdditionsFacilityClass"/>
    3456           and has a current status indicated by <xref linked="AdditionsFacilityStatus"
     3454          <xref linkend="AdditionsFacilityClass" xreflabel="AdditionsFacilityClass"/>
     3455          and has a current status indicated by <xref linkend="AdditionsFacilityStatus"
    34573456          xreflabel="AdditionsFacilityStatus"/>, together with a timestamp (in ms) of
    34583457          the last status update.</para>
    … …  
    34613460              <listitem>
    34623461                <para>
    3463                   In the <xref linked="IGuest" xreflabel="IGuest"/> interface, the following were removed:
     3462                  In the <xref linkend="IGuest" xreflabel="IGuest"/> interface, the following were removed:
    34643463                  <itemizedlist>
    34653464                    <listitem>
    … …  
    34743473              <listitem>
    34753474                <para>
    3476                   The function <xref linked="IGuest__getFacilityStatus" xreflabel="IGuest::getFacilityStatus()"/>
     3475                  The function <xref linkend="IGuest__getFacilityStatus" xreflabel="IGuest::getFacilityStatus()"/>
    34773476                  was added. It quickly provides a facility's status without the need to get the facility
    3478                   collection with <xref linked="IGuest__facilities" xreflabel="IGuest::facilities"/>.
     3477                  collection with <xref linkend="IGuest__facilities" xreflabel="IGuest::facilities"/>.
    34793478                </para>
    34803479              </listitem>
    34813480              <listitem>
    34823481                <para>
    3483                   The attribute <xref linked="IGuest__facilities" xreflabel="IGuest::facilities"/>
     3482                  The attribute <xref linkend="IGuest__facilities" xreflabel="IGuest::facilities"/>
    34843483                  was added to provide an easy to access collection of all currently known guest
    34853484                  facilities, that is, it contains all facilies where at least one status update was
    … …  
    34893488              <listitem>
    34903489                <para>
    3491                   The interface <xref linked="IAdditionsFacility" xreflabel="IAdditionsFacility"/>
     3490                  The interface <xref linkend="IAdditionsFacility" xreflabel="IAdditionsFacility"/>
    34923491                  was added to represent a single facility returned by
    3493                   <xref linked="IGuest__facilities" xreflabel="IGuest::facilities"/>.
     3492                  <xref linkend="IGuest__facilities" xreflabel="IGuest::facilities"/>.
    34943493                </para>
    34953494              </listitem>
    34963495              <listitem>
    34973496                <para>
    3498                   <xref linked="AdditionsFacilityStatus" xreflabel="AdditionsFacilityStatus"/>
     3497                  <xref linkend="AdditionsFacilityStatus" xreflabel="AdditionsFacilityStatus"/>
    34993498                  was added to represent a facility's overall status.
    35003499                </para>
    … …  
    35023501              <listitem>
    35033502                <para>
    3504                   <xref linked="AdditionsFacilityType" xreflabel="AdditionsFacilityType"/> and
    3505                   <xref linked="AdditionsFacilityClass" xreflabel="AdditionsFacilityClass"/> were
     3503                  <xref linkend="AdditionsFacilityType" xreflabel="AdditionsFacilityType"/> and
     3504                  <xref linkend="AdditionsFacilityClass" xreflabel="AdditionsFacilityClass"/> were
    35063505                  added to represent the facility's type and class.
    35073506                </para>
    … …  
    40714070
    40724071        <listitem>
    4073           <para>The <xref linkend="IVRDPServer" xreflabel="IVRDPServer" />,
    4074           <xref linkend="IRemoteDisplayInfo" xreflabel="IRemoteDisplayInfo" />
    4075           and IConsoleCallback interfaces were changed to reflect VRDP server
    4076           ability to bind to one of available ports from a list of
    4077           ports.</para>
     4072          <para>The <computeroutput>IVRDPServer</computeroutput>,
     4073          <computeroutput>IRemoteDisplayInfo"</computeroutput> and
     4074          <computeroutput>IConsoleCallback</computeroutput> interfaces were
     4075          changed to reflect VRDP server ability to bind to one of available
     4076          ports from a list of ports.</para>
    40784077
    40794078          <para>The <computeroutput>IVRDPServer::port</computeroutput>
    4080           attribute has been replaced with <xref linkend="IVRDPServer__ports"
    4081           xreflabel="IVRDPServer::ports" />, which is a comma-separated list
    4082           of ports or ranges of ports.</para>
    4083 
    4084           <para>An <xref linkend="IRemoteDisplayInfo__port"
    4085           xreflabel="IRemoteDisplayInfo::port" /> attribute has been added for
    4086           querying the actual port VRDP server listens on.</para>
     4079          attribute has been replaced with
     4080          <computeroutput>IVRDPServer::ports</computeroutput>, which is a
     4081          comma-separated list of ports or ranges of ports.</para>
     4082
     4083          <para>An <computeroutput>IRemoteDisplayInfo::port"</computeroutput>
     4084          attribute has been added for querying the actual port VRDP server
     4085          listens on.</para>
    40874086
    40884087          <para>An IConsoleCallback::onRemoteDisplayInfoChange() notification

  • trunk/doc/manual/en_US/user_Networking.xml

    r34606 r36952  
    6363    manager. As an exception, the Intel PRO/1000 family adapters are chosen
    6464    for some guest operating system types that no longer ship with drivers for
    65     the PCNet card, such as Windows Vista; see <xref
    66     linkend="vista_networking" /> for details.<footnote>
    67         <para>Support for the Intel PRO/1000 MT Desktop type was added with
    68         VirtualBox 1.6. The T Server variant of the Intel PRO/1000 card was
    69         added with VirtualBox 1.6.2 because this one is recognized by Windows
    70         XP guests without additional driver installation. The MT Server
    71         variant was added with VirtualBox 2.2 to facilitate OVF imports from
    72         other platforms.</para>
    73       </footnote></para>
     65    the PCNet card, such as Windows Vista.</para>
     66
     67    <para>The Intel PRO/1000 MT Desktop type works with Windows Vista and later
     68    versions. The T Server variant of the Intel PRO/1000 card is recognized by
     69    Windows XP guests without additional driver installation. The MT Server
     70    variant facilitates OVF imports from other platforms.</para>
    7471
    7572    <para>The <emphasis role="bold">"Paravirtualized network adapter

  • trunk/doc/manual/en_US/user_Security.xml

    r36007 r36952  
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
    33"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
    4 <chapter id="Troubleshooting">
     4<chapter id="Security">
    55  <title>Security considerations</title>
    66

  • trunk/doc/manual/en_US/user_Troubleshooting.xml

    r35291 r36952  
    711711      Intel E1000 card by default.</para>
    712712
    713       <para>If, for some reason, you still want to use the AMD card,
    714       VirtualBox ships a 32-bit driver for that card with the Windows Guest
    715       Additions; see <xref linkend="vista_networking" />.</para>
     713      <para>If, for some reason, you still want to use the AMD card, you need
     714      to download the PCNet driver from the AMD website (available for 32-bit
     715      Windows only). You can transfer it into the virtual machine using a
     716      shared folder, see (see <xref linkend="sharedfolders" />).</para>
    716717    </sect2>
    717718
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette