Changeset 28220 for trunk/doc


Ignore:
Timestamp:
Aug 25, 2007, 12:54:55 AM (12 years ago)
Author:
markd@…
Message:

Add a small section describing flat file registry files.

File:
1 edited

Legend:

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

    r28037 r28220  
    252252      <title>sources.conf</title>
    253253
    254       <para><filename>sources.conf</filename> is where the location(s) to
    255       retrieve the MacPorts <filename>Portfile</filename>s is set.</para>
     254      <para><filename>sources.conf</filename> is where the location(s) are set
     255      to scan for MacPorts Portfiles. This file is commonly modified to add a
     256      local Portfile repository.</para>
    256257    </section>
    257258
     
    302303    <para>MacPorts contains two application programming interfaces (APIs),
    303304    written in Tcl: The Ports API and the MacPorts (mport*) API. The former is
    304     an internal API used for individual <filename>Portfile</filename>s. The
    305     latter is a high-level API used by client applications such as the
    306     MacPorts port utility.</para>
     305    an internal API used for individual Portfiles. The latter is a high-level
     306    API used by client applications such as the MacPorts port utility.</para>
    307307
    308308    <section id="macports-internals.macports.apis.ports">
     
    496496    <title>The MacPorts Registry</title>
    497497
    498     <para>This chapter provides a detailed overview of the MacPorts registry
    499     and its API. The registry is queried by MacPorts utilities for information
    500     about installed ports related to dependencies, port images, and simple
    501     user information about what is installed. It also provides abstraction
    502     over a modular receipt storage layer, allowing for flat-file receipts, as
    503     well as receipts stored in a SQLite database.</para>
     498    <para>This chapter provides an overview of the MacPorts registry and its
     499    API. The registry is queried by MacPorts utilities for information about
     500    installed ports related to dependencies, port images, and simple user
     501    information about what is installed. It provides abstraction over a
     502    modular receipt storage layer; this allows for flat file receipts as well
     503    as receipts stored in a SQLite database.</para>
    504504
    505505    <para>The registry allows MacPorts utilities to:</para>
     
    522522    </itemizedlist>
    523523
     524    <section>
     525      <title>Registry Files</title>
     526
     527      <para>The flat file registry (MacPorts default registry) files are
     528      contained in <filename>${portdbpath}/receipts</filename>, which by
     529      default is location
     530      <filename>${prefix}/var/macports/receipts</filename>. File mappings and
     531      dependency mappings are tracked in the flat file registry by these
     532      files:</para>
     533
     534      <simplelist>
     535        <member>file_map.db</member>
     536
     537        <member>dep_map.bz2</member>
     538      </simplelist>
     539    </section>
     540
    524541    <section id="macports-internals.macports.registry.registry.api">
    525542      <title>The Registry API</title>
Note: See TracChangeset for help on using the changeset viewer.