From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id 17CF81381F3 for ; Fri, 9 Aug 2013 15:28:10 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 66244E0A96; Fri, 9 Aug 2013 15:28:04 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id E685FE0A96 for ; Fri, 9 Aug 2013 15:28:03 +0000 (UTC) Received: from hornbill.gentoo.org (hornbill.gentoo.org [94.100.119.163]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id C2EE333EC03 for ; Fri, 9 Aug 2013 15:28:02 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by hornbill.gentoo.org (Postfix) with ESMTP id 46219E546B for ; Fri, 9 Aug 2013 15:28:00 +0000 (UTC) From: "André Erdmann" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "André Erdmann" Message-ID: <1376061806.e6b6f976f718b048c80bd1ce707523c1f2fa7d97.dywi@gentoo> Subject: [gentoo-commits] proj/R_overlay:master commit in: doc/html/ X-VCS-Repository: proj/R_overlay X-VCS-Files: doc/html/usage.html X-VCS-Directories: doc/html/ X-VCS-Committer: dywi X-VCS-Committer-Name: André Erdmann X-VCS-Revision: e6b6f976f718b048c80bd1ce707523c1f2fa7d97 X-VCS-Branch: master Date: Fri, 9 Aug 2013 15:28:00 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: f2cc5a76-1e28-43cc-9207-52ed2cb98924 X-Archives-Hash: e497666077647014ca9e9423a5fb25b3 commit: e6b6f976f718b048c80bd1ce707523c1f2fa7d97 Author: André Erdmann mailerd de> AuthorDate: Fri Aug 9 15:23:26 2013 +0000 Commit: André Erdmann mailerd de> CommitDate: Fri Aug 9 15:23:26 2013 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=proj/R_overlay.git;a=commit;h=e6b6f976 doc/html/usage.html (generated file) --- doc/html/usage.html | 133 ++++++++++++++++++++++++++++++++++------------------ 1 file changed, 87 insertions(+), 46 deletions(-) diff --git a/doc/html/usage.html b/doc/html/usage.html index 55ad457..86ea414 100644 --- a/doc/html/usage.html +++ b/doc/html/usage.html @@ -362,7 +362,7 @@ ul.auto-toc {
  • 5.3   Getting packages from a repository that supports http only
  • 5.4   Getting packages from several remotes using http and a package list
  • 5.5   Using local directories
    • -
  • 5.6   distmap
    • +
  • 5.6   Distmap
  • 6   Additions Directory
      @@ -537,46 +537,49 @@ Reading the other chapters (4-14) is recommended.

      2.1   Prerequisites

        -

      • python >= 2.7 (tested with python 2.7 and 3.2)

        -
        • -

      • argparse (http://code.google.com/p/argparse)

        +

      • python >= 2.7 built with ssl support (tested with python 2.7 and 3.2)

        +
        +

        extra dependencies for python 2.7 (built-in since python 3.2)

        + +

      • setuptools (http://pypi.python.org/pypi/setuptools)

      • rsync (for using rsync repositories)

        • -

      • for Manifest creation:

        -
          -
        • portage (ebuild)
          • -
        • true or echo from coreutils or busybox for preventing -package downloads during Manifest creation (optional)
          • -
        +

      • portage (ebuild) for Manifest creation and downloading source files for +imported ebuilds

        +
        • +

      • true or echo from coreutils or busybox for preventing +package downloads during Manifest creation (optional)

      • for generating documentation files: python docutils >= 0.9

      • hardware requirements (when using the default configuration):

        -
        -
        disk
        -
          +

          disk

          +
          • 50-55GB disk space for the R packages
          • a filesystem that supports symbolic or hard links
          • there will be many small-sized files (ebuilds), so a filesystem with lots of inodes and a small block size may be advantageous
          -
        -
        memory
        -

        up to 600MB which depends on the amount of processed packages and the +

        memory

        +
        +

        up to 600MB which depends on the amount of processed packages and the write mechanism in use. The amount can be halved (approximately) when using a slower one.

        -
        -
        time
        -

        Expect 1h execution time for the first run, depending on computing +

        +

        time

        +
        +

        Expect 1h execution time for the first run, depending on computing and I/O speed. roverlay is able to work in incremental mode, thus making subsequent runs need a lot less time.

        - - +
      @@ -816,10 +819,16 @@ they work.
      Main Config
      See Configuration Reference for all main config options like log file rotation and assistance for writing new dependency rules.
      +
      Patching generated ebuilds / Importing ebuilds
      +
      See Additions Directory.
      +
      R_SUGGESTS
      +
      See USE_EXPAND flag rename file, which describes how R_SUGGESTS +USE_EXPAND flags can be renamed.
      Field Definition
      Refer to Field Definition in case you want to change how R packages are being read, e.g. if you want the 'Depents' information field (obviously -a typo) to be understood as 'Depends'.
      +a typo) to be understood as 'Depends'. Also see License Map file for +translating license strings into valid portage licenses.
      @@ -963,6 +972,8 @@ been done, either to stdout or to This command implies the sync command unless the --nosync option is specified.

      +
      setupdirs
      +
      Creates all configured directories with proper permissions.
      @@ -986,7 +997,7 @@ most cases, but fine-tuning can be done via hook environment.

      roverlay-related scripts can use it to automatically inherit roverlay's config and get access to its $FUNCTIONS file:

      -
      +
       #!/usr/bin/roverlay-sh
 
 # load the functions file (optional)
@@ -995,13 +1006,20 @@ config and get access to its $FUNCTIONS file:<
 # script body
 true
 
      
+
      
+
      Note
      
+
      roverlay-sh requires a valid config file.
      
+
      
 
 
      roverlay-mkconfig
      
 
      a script that creates a config file for roverlay
      
-
      name_is_todo--roverlay_creation_helper
      
-
      <<TODO>>
-Safely runs overlay creation <<and $$afterwards>>.
-Suitable for being run as cron job.
      
+
      run-roverlay.sh
      
+
      A script that safely runs overlay creation and repoman afterwards.
+Uses filesystem locks to ensure that it is run at most once at a time.
+Suitable for being run as cron job.
      
+
      This file is not part of the roverlay installation. It can be found
+at files/scripts/run-roverlay.sh in the roverlay git repo.
      
+
      @@ -1023,19 +1041,21 @@ Suitable for being run as cron job.

    • all repositories are asked to list their packages which are then added to a queue

      • -

    • packages may be declined by the overlay creator if they already have -an ebuild

      -

    • packages may be declined or manipulated by package rules

      See also: Package Rules

      • +

    • packages may be declined by the overlay creator if they already have +an ebuild

      +

      The overlay is able to detect changes to the package file, e.g. when +upstream modified a package without renaming it. To realize this, +the package file's checksum (sha256) is compared with the ebuild's +entry in the distmap. If they do match, then the package is declined +as it already exists. Otherwise, a revision bump is triggered.

      +

  • create - process each package p from the package queue (thread-able on a per package basis)

    -
    • - -

    • read p's DESCRIPTION file that contains information fields like 'Depends', 'Description' and 'Suggests'

      @@ -1051,6 +1071,10 @@ cannot be resolved in which case a valid ebuild cannot be created

    • verify dependencies on packages found in the overlay, whether their ebuilds already exist or not (selfdep validation)

      +
        +
      • drop unsatisfiable selfdeps
        • +
      • stop processing p if a required selfdep is missing
        • +

      See also: Dependency Resolution

    @@ -1062,27 +1086,31 @@ and a few information fields like 'Description'

    and may decide to write p's ebuild now (or later)

    -
    -
      -
    1. write the overlay
        -
      • write/update the profiles dir
          + +

        • write the overlay

          +
            +
          • write/update the profiles dir and metadata/layout.conf
            • roverlay respects manual changes to USE_EXPAND description files
            • -
          • write all ebuilds and apply patches to them -(supports threads on a per package basis)
            • -
          • write the metadata.xml files -(supports threads on a per package basis)
              +
            • write all ebuilds and apply patches to them
              • +
            • write the metadata.xml files
              • this uses the latest created ebuild available for a package
              • -
            • write the Manifest files -(does not support threads by default / supports threads on a per package -basis when using portage directly)
                +
              • write the Manifest files
                • this uses all ebuilds availabe for a package
              +

              Most write operations support threading.

              +
              • +

            • call the overlay_success hook

              +
              • +

            • write the stats database file (optional)

              +
                +
              • call the db_written hook
                • +
    @@ -1446,7 +1474,7 @@ consider using one of the websync repo types, -

    5.6   distmap

    +

    5.6   Distmap

    roverlay uses a text file to store information about files in the package mirror directory (OVERLAY_DISTDIR_ROOT). This is necessary for comparing package files from repos with files for which an ebuild has already been @@ -2879,6 +2907,19 @@ the distmap file.

    This option is required.

    +
    +
    STATS_DB
    +

    Path to the stats database file. This has to be a round-robin database +file (rrdtool). roverlay creates it if necessary.

    +

    Defaults to <not set>, which disable database writing.

    +
    +
    STATS_INTERVAL
    +

    Database update interval, which should be set to the expected timespan +between running overlay creation, in seconds. Only meaningful when +creating a new database file.

    +

    Defaults to 7200 (2 hours).

    +
    +
    DISTFILES
    Alias to DISTFILES_ROOT.
    @@ -4666,7 +4707,7 @@ becomes "loop until resolver closes".

    -Generated on: 2013-08-07. +Generated on: 2013-08-09.