From 0e0a7b8e649283837c3126c1160c977b32191656 Mon Sep 17 00:00:00 2001 From: P. J. McDermott Date: Tue, 31 Jul 2012 09:49:00 -0400 Subject: Rewrite opkbuild, add natural language support. --- (limited to 'man') diff --git a/man/opkhelper.7.in b/man/opkhelper.7.in index 815d6f1..e71e935 100644 --- a/man/opkhelper.7.in +++ b/man/opkhelper.7.in @@ -1,6 +1,6 @@ .\" Author: Patrick "P. J." McDermott .TH opkhelper 7 \ -"2012-04-26" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools" +"2012-07-29" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools" .SH NAME opkhelper \- opkg build helper tools @@ -12,9 +12,9 @@ by the lightweight package manager These tools are inspired by debhelper, a similar set of programs written primarily by Joey Hess for Debian. .sp -opkhelper is designed to build source packages that comply with draft version -1.0 of the source package format at -.IR http://specs.os.pehjota.net/source-package-format-1.0.html . +opkhelper 2.0.x is designed to build source packages that comply with draft +version 2.0 of the source package format at +.IR http://specs.os.pehjota.net/source-package-format-2.0.html . .SH MAINTAINER AND PACKAGE INTERFACES opkhelper exposes various interfaces to users building packages and to packages @@ -92,7 +92,7 @@ files. .SH ENVIRONMENT VARIABLES opkbuild makes available to package -.I build +.IR config and build files and other opkhelper tools a number of environment variables that describe the packages being built, the build and host systems, and the toolchain to be used. The difference between "build" and "host" systems follows the convention @@ -100,17 +100,27 @@ set by GNU Autoconf. The build system is the one on which software is built. The host system is the one on which software is to be run. For more information, see .IR https://www.gnu.org/software/autoconf/manual/autoconf.html#Specifying-Targe\ t-Triplets . + +.SS PACKAGE .TP -.B OH_SRCPKG -The name of the source package +.B OH_SOURCE +The source package name .TP -.B OH_PKGVER -The version of the source package +.B OH_SOURCE_VERSION +The source package version .TP -.B OH_BINPKG -The name of the current binary package +.B OH_SOURCE_VERSION_UPSTREAM +The upstream source package version (which may include a Software Inclusion +Policy revision number) .TP -.B OH_BUILD_ARCH_DIST +.B OH_BINARY_VERSION +The binary package version (which is different from +.B OH_SOURCE_VERSION +during a binary rebuild) + +.SS BUILD AND HOST SYSTEMS +.TP +.B OH_BUILD_ARCH Build system distribution architecture string .TP .B OH_BUILD_ARCH_CPU @@ -131,9 +141,9 @@ Build system GNU system type .B OH_BUILD_ARCH_KBUILD Build system kbuild srchitecture name .sp -This is likely to be deprecated and removed in the near future. +This is deprecated. .TP -.B OH_HOST_ARCH_DIST +.B OH_HOST_ARCH Host system distribution architecture string .TP .B OH_HOST_ARCH_CPU @@ -154,85 +164,61 @@ Host system GNU system type .B OH_HOST_ARCH_KBUILD Host system kbuild srchitecture name .sp -This is likely to be deprecated and removed in the near future. +This is deprecated. +.TP +.B ARCH +Host system architecture name as used by kbuild. +.sp +This is deprecated. + +.SS TOOLS .TP .B AR -"ar" with cross toolchain prefix, if any +"ar" with cross toolchain prefix .TP .B AS -"as" with cross toolchain prefix, if any +"as" with cross toolchain prefix .TP .B CC -"gcc" with cross toolchain prefix, if any +"gcc" with cross toolchain prefix .TP .B CPP -"cpp" with cross toolchain prefix, if any +"cpp" with cross toolchain prefix .TP .B CXX -"g++" with cross toolchain prefix, if any +"g++" with cross toolchain prefix .TP .B LD -"ld" with cross toolchain prefix, if any +"ld" with cross toolchain prefix .TP .B NM -"nm" with cross toolchain prefix, if any +"nm" with cross toolchain prefix .TP .B OBJCOPY -"objcopy" with cross toolchain prefix, if any +"objcopy" with cross toolchain prefix .TP .B OBJDUMP -"objdump" with cross toolchain prefix, if any +"objdump" with cross toolchain prefix .TP .B RANLIB -"ranlib" with cross toolchain prefix, if any +"ranlib" with cross toolchain prefix .TP .B READELF -"readelf" with cross toolchain prefix, if any +"readelf" with cross toolchain prefix .TP .B SIZE -"size" with cross toolchain prefix, if any +"size" with cross toolchain prefix .TP .B STRINGS -"strings" with cross toolchain prefix, if any +"strings" with cross toolchain prefix .TP .B STRIP -"strip" with cross toolchain prefix, if any -.TP -.B ARCH -Host system architecture name as used by kbuild. -.sp -This is likely to be deprecated and removed in the near future. +"strip" with cross toolchain prefix .TP .B CROSS_COMPILE -Cross toolchain prefix, if any, as used by kbuild. +Cross toolchain prefix as used by kbuild. .sp -This is likely to be deprecated and removed in the near future. - -.SH EXAMPLES -The following is an example -.I build -makefile, showing the use of opkhelper tools and environment variables: -.sp -.nf -#! /usr/bin/make -f - -PKGS = xmlwf xmlwf-doc libexpat.1 libexpat.1-dev libexpat.1-dbg - -$(PKGS): expat.buildstamp - -\a.SILENT: expat.buildstamp -expat.buildstamp: - cd src && \\ - ./configure --prefix=/usr \\ - --build=$${OH_BUILD_ARCH_GNU} --host=$${OH_HOST_ARCH_GNU} && \\ - make && make DESTDIR=$$(pwd)/../dest install - oh-strip -gl /usr/lib/libexpat.so.1.6.0 - oh-installfiles $(PKGS) - oh-installdocs libexpat.1 - oh-gencontrol $(PKGS) - oh-buildopk $(PKGS) - touch expat.buildstamp -.fi +This is deprecated. .SH COPYRIGHT Copyright (C) 2012 Patrick "P. J." McDermott -- cgit v0.9.1