Changeset 28606 for trunk/doc


Ignore:
Timestamp:
Sep 4, 2007, 4:32:25 PM (12 years ago)
Author:
markd@…
Message:

Add missing section ID (thanks Simon R.), add some markup, and adjust some text.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/new/xml/internals.xml

    r28577 r28606  
    398398      case it sets the variable name in the sub-interpreter and adds the
    399399      option to the sub-interpreter's global array user_options(). User
    400       options are passed as part of the call to mportopen. </para>
     400      options are passed as part of the call to <code>mportopen</code>.</para>
    401401
    402402      <para>The MacPorts API performs the following functions:</para>
     
    404404      <itemizedlist>
    405405        <listitem>
    406           <para>Dependency implementation. This portion is implemented in a
    407           highly generic fashion, and is used throughout the system. The
    408           dependency functions are exported to the Port API, and the Port API
    409           uses them to execute targets in the correct order.</para>
    410         </listitem>
    411 
    412         <listitem>
    413           <para>Software dependencies. Software dependencies are handled at
    414           this layer using the dependency implementation.</para>
    415         </listitem>
    416 
    417         <listitem>
    418           <para>UI abstractions. UI Abstractions are handled at this layer.
    419           Each port action is provided a context, and a mechanism for posting
    420           user interface events is exported to the Port API (ui_event).</para>
    421         </listitem>
    422 
    423         <listitem>
    424           <para>Registry management routines. Manages the rudimentary port
    425           registry in
     406          <para>Dependency support.</para>
     407
     408          <para>This is implemented in a highly generic fashion, and is used
     409          throughout the system. The dependency functions are exported to the
     410          Port API, and the Port API uses them to execute targets in the
     411          correct order.</para>
     412        </listitem>
     413
     414        <listitem>
     415          <para>Dependency processing.</para>
     416
     417          <para>Software dependencies are handled at this layer using the
     418          dependency support layer.</para>
     419        </listitem>
     420
     421        <listitem>
     422          <para>UI abstractions.</para>
     423
     424          <para>UI Abstractions are handled at this layer. Each port action is
     425          provided a context, and a mechanism for posting user interface
     426          events is exported to the Port API (ui_event).</para>
     427        </listitem>
     428
     429        <listitem>
     430          <para>Registry management routines.</para>
     431
     432          <para>Manages the rudimentary port registry in
    426433          <filename>${prefix}/var/mports/receipts/</filename>.</para>
    427434
    428435          <itemizedlist>
    429436            <listitem>
    430               <para>mportregistry::new: create a new port registry
     437              <para><code>mportregistry::new:</code> create a new port
     438              registry entry.</para>
     439            </listitem>
     440
     441            <listitem>
     442              <para><code>mportregistry::exists:</code> check if a port
     443              registry entry exists (either versioned or not).</para>
     444            </listitem>
     445
     446            <listitem>
     447              <para><code>mportregistry::delete:</code> delete an existing
     448              registry entry.</para>
     449            </listitem>
     450
     451            <listitem>
     452              <para><code>mportregistry::close:</code> closes a new registry
    431453              entry.</para>
    432454            </listitem>
    433 
    434             <listitem>
    435               <para>mportregistry::exists: check if a port registry entry
    436               exists (either versioned or not).</para>
    437             </listitem>
    438 
    439             <listitem>
    440               <para>mportregistry::delete: delete an existing registry
    441               entry.</para>
    442             </listitem>
    443 
    444             <listitem>
    445               <para>mportregistry::close: closes a new registry entry.</para>
    446             </listitem>
    447455          </itemizedlist>
    448456        </listitem>
     
    450458        <listitem>
    451459          <para>Exports the MacPorts API for use by client
    452           applications:</para>
     460          applications.</para>
     461
     462          <para>The following routines are defined.</para>
    453463
    454464          <itemizedlist>
    455465            <listitem>
    456               <para>mportinit: Initializes the MacPorts system. Should be
    457               called before trying to use any other procedure.</para>
    458             </listitem>
    459 
    460             <listitem>
    461               <para>mportsearch: Given a regexp, searches the PortIndex for
    462               ports with matching names.</para>
    463             </listitem>
    464 
    465             <listitem>
    466               <para>mportopen: Given a URI to a port, opens the port and
    467               returns an opaque handle to it.</para>
    468             </listitem>
    469 
    470             <listitem>
    471               <para>portclose: Given a port handle, closes the port.</para>
    472             </listitem>
    473 
    474             <listitem>
    475               <para>mportexec: Given a port handle, executes a target (i.e.
    476               install).</para>
    477             </listitem>
    478 
    479             <listitem>
    480               <para>mportinfo: Given a port handle, this returns the PortInfo
    481               array (as a flat list of array elements). This is a little
    482               tricky and unstable and only used by the
     466              <para><code>mportinit:</code> Initializes the MacPorts system.
     467              Should be called before trying to use any other
     468              procedure.</para>
     469            </listitem>
     470
     471            <listitem>
     472              <para><code>mportsearch:</code> Given a regexp, searches the
     473              <filename>PortIndex</filename> for ports with matching
     474              names.</para>
     475            </listitem>
     476
     477            <listitem>
     478              <para><code>mportopen:</code> Given a URI to a port, opens a
     479              Portfile and returns an opaque handle to it.</para>
     480            </listitem>
     481
     482            <listitem>
     483              <para><code>portclose:</code> Given a port handle, closes a
     484              Portfile.</para>
     485            </listitem>
     486
     487            <listitem>
     488              <para><code>mportexec:</code> Given a port handle, executes a
     489              target (i.e. install).</para>
     490            </listitem>
     491
     492            <listitem>
     493              <para><code>mportinfo:</code> Given a port handle, this returns
     494              the PortInfo array (as a flat list of array elements). This is a
     495              little tricky and unstable and only used by the
    483496              <command>portindex</command> command.</para>
    484497            </listitem>
    485498
    486499            <listitem>
    487               <para>mportdepends: Given a port handle, returns a list of ports
    488               upon which the specified port depends.</para>
     500              <para><code>mportdepends:</code> Given a port handle, returns a
     501              list of ports upon which the specified port depends.</para>
    489502            </listitem>
    490503          </itemizedlist>
     
    497510      <itemizedlist>
    498511        <listitem>
    499           <para>Calls the mportsearch function to find all ports containing
    500           "cm3".</para>
     512          <para>Calls the <code>mportsearch</code> function to find all ports
     513          containing "cm3".</para>
    501514        </listitem>
    502515
     
    518531      <itemizedlist>
    519532        <listitem>
    520           <para>Calls the mportsearch function to find the first port that
    521           matches the name "cm3".</para>
    522         </listitem>
    523 
    524         <listitem>
    525           <para>Calls the mportopen function to open the port.</para>
    526         </listitem>
    527 
    528         <listitem>
    529           <para>Calls the mportexec function to execute the install target in
    530           the port.</para>
    531         </listitem>
    532 
    533         <listitem>
    534           <para>Calls the mportclose function to close the port.</para>
     533          <para>Calls the <code>mportsearch</code> function to find the first
     534          port that matches the name "cm3".</para>
     535        </listitem>
     536
     537        <listitem>
     538          <para>Calls the <code>mportopen</code> function to open the
     539          port.</para>
     540        </listitem>
     541
     542        <listitem>
     543          <para>Calls the <code>mportexec</code> function to execute the
     544          install target in the port.</para>
     545        </listitem>
     546
     547        <listitem>
     548          <para>Calls the <code>mportclose</code> function to close the
     549          port.</para>
    535550        </listitem>
    536551      </itemizedlist>
    537552    </section>
    538553
    539     <section>
     554    <section id="internals.apis.pextlib">
    540555      <title>pextlib</title>
    541556
Note: See TracChangeset for help on using the changeset viewer.