MiniPortile 技术文档

本文档旨在帮助用户详细理解并使用 MiniPortile 项目。以下是项目的主要部分，包括安装指南、使用说明和 API 使用文档。

1. 安装指南

在开始之前，请确保您的系统中已安装以下依赖：

• Ruby 环境
• GCC 或 Clang 编译器
• make 或 nmake 工具

安装 MiniPortile

您可以通过 Ruby 的包管理器 gem 来安装 MiniPortile：

gem install mini_portile2

确保安装的是 mini_portile2 版本，因为旧版本的 mini_portile 可能不兼容。

2. 项目的使用说明

MiniPortile 是一个为开发者设计的轻量级端口/食谱系统，用于确保开发者可以重现用户的依赖和环境。

使用方法（针对 autoconf 项目）

以下是一个快速示例：

gem "mini_portile2", "~> 2.0.0" # 在 extconf.rb 中使用时必需
require "mini_portile2"
recipe = MiniPortile.new("libiconv", "1.13.1")
recipe.files = ["http://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.13.1.tar.gz"]
recipe.cook
recipe.activate

cook 方法会下载、解压、补丁、配置和编译库到命名空间结构中。

activate 方法确保 GCC 能找到这个库并优先于系统范围内的安装。

配置编译器

您可以配置 C 和 C++ 编译器命令：

MiniPortile.new("libiconv", "1.13.1", cc_command: "clang", cxx_command: "clang++")

配置 make 命令

MiniPortile.new("libiconv", "1.13.1", make_command: "nmake")

超时设置

您可以设置下载源存档时的超时时间：

MiniPortile.new("libiconv", "1.13.1", open_timeout: 99, read_timeout: 2)

使用方法（针对 cmake 项目）

与 autoconf 项目类似，但使用 MiniPortileCMake.new。

MiniPortileCMake.new("libfoobar", "1.3.5", cmake_command: "cmake3", cmake_build_type: "Debug")

本地源目录

您也可以指向本地源目录：

recipe.source_directory = "/path/to/local/source/for/library-1.2.3"

目录结构约定

MiniPortile 遵循约定优于配置的原则，并建立了一个文件夹结构来放置文件和执行操作。

mylib
  |-- ports
  |   |-- archives
  |   |   `-- libiconv-1.13.1.tar.gz
  |   `-- <platform>
  |       `-- libiconv
  |           `-- 1.13.1
  |               |-- bin
  |               |-- include
  |               `-- lib
  `-- tmp
      `-- <platform>
          `-- ports

在这里，<platform> 代表您使用的操作系统架构（例如 i686-linux, i386-mingw32 等）。

在平台文件夹内，MiniPortile 会存储编译过程的工件。库是版本化的，因此您可以在磁盘上保留多个版本，而不会相互覆盖。

archives 文件夹是用于缓存下载的源文件。建议不要删除此文件夹，以避免多次下载相同的文件。

tmp 文件夹是编译执行的地方，可以安全地删除。

使用食谱的 #path 方法来获取安装目录的完整路径：

recipe.cook
recipe.path # => /home/luis/projects/myapp/ports/i686-linux/libiconv/1.13.1

3. 项目 API 使用文档

MiniPortile 提供了以下 API 方法：

• new(library, version, options)：创建一个新的 MiniPortile 对象。
• cook：下载、解压、补丁、配置和编译库。
• activate：确保编译的库可以被 GCC 找到并优先使用。
• path：返回安装目录的完整路径。

更多细节请参考官方文档。

4. 项目安装方式

MiniPortile 的安装方式已在安装指南中说明。您可以通过 Ruby gem 来安装它：

gem install mini_portile2

确保遵循上述步骤进行正确安装和使用。