From bb03d7a6170ae5d1fa950170ed5739f9b05bed5b Mon Sep 17 00:00:00 2001 From: =?utf8?q?Mat=C3=ADas=20Fonzo?= Date: Thu, 4 Apr 2019 14:09:22 -0300 Subject: [PATCH] qi: doc: corrections coming from Antonio Diaz Diaz --- qi/CREDITS | 6 +- qi/README | 14 +- qi/doc/qi.1 | 6 +- qi/doc/qi.html | 438 +++++++++++++++++++++++++-------------------- qi/doc/qi.info | 194 ++++++++++---------- qi/doc/qi.texi | 165 ++++++++--------- qi/src/qi.in | 15 +- recipes/tools/graft/recipe | 16 +- recipes/tools/qi/recipe | 25 ++- 9 files changed, 472 insertions(+), 407 deletions(-) diff --git a/qi/CREDITS b/qi/CREDITS index d6593267..c2a939f9 100644 --- a/qi/CREDITS +++ b/qi/CREDITS @@ -20,18 +20,18 @@ S: Spain N: Alan Beadle E: ab.beadle@gmail.com -D: Correctness and suggestions on English messages. +D: Correctness and suggestions in English messages. S: USA N: Eduardo A. Bustamante Lopez W: https://dualbus.me E: dualbus@gmail.com -D: Code snippets, examples, suggestions. +D: Code snippets, examples, and suggestions. S: Mexico N: Ben Zanin E: bzanin@gmail.com -D: Regular expression used for ed(1). +D: "POSIX" regular expression used for ed(1). S: Canada N: Peter Samuel diff --git a/qi/README b/qi/README index 42c826d0..6fc1b30f 100644 --- a/qi/README +++ b/qi/README @@ -10,18 +10,18 @@ 1. Introduction. -Qi is a simple but well-integrated package manager. It can creates, +Qi is a simple but well-integrated package manager. It can create, install, remove, and upgrade software packages. Qi produces binary -packages using recipe names, these are files containing specific -instructions to build every source. Qi can manage multiple packages -under a single directory hierarchy, this method allows to maintain a set -of packages and multiple versions of them. This means that Qi could be -used as the main package manager or complement the existing one. +packages using recipes, which are files containing specific instructions +to build each package from source. Qi can manage multiple packages +under a single directory hierarchy. This method allows to maintain a +set of packages and multiple versions of them. This means that Qi could +be used as the main package manager or complement the existing one. Qi offers a friendly command line interface, a global configuration file, a simple recipe layout to deploy software packages; also works with binary packages in parallel, speeding up installations and packages -in production. The used format for packages is a simplified but safe +in production. The format used for packages is a simplified but safe POSIX pax archive compressed with lzip. Qi is a modern (POSIX-compliant) shell script released under the diff --git a/qi/doc/qi.1 b/qi/doc/qi.1 index 8aa5ab7a..7099c6eb 100644 --- a/qi/doc/qi.1 +++ b/qi/doc/qi.1 @@ -54,8 +54,8 @@ Target directory for symbolic links. Only valid for \fB\-i\fR, \fB\-d\fR, or \fB\-u\fR options .TP \fB\-k\fR -Keep `${srcdir}' or `${destdir}' on build mode, -keep package directory on delete mode. +Keep `${srcdir}' or `${destdir}' in build mode, +keep package directory in delete mode. .IP Only valid for \fB\-b\fR, \fB\-d\fR or \fB\-u\fR options .TP @@ -74,7 +74,7 @@ Be verbose (a 2nd \fB\-v\fR gives more) .SS "Options for 'build' mode (-b):" .TP \fB\-O\fR - Where the produced packages are written + Where the packages produced are written .TP \fB\-W\fR Where archives, patches, and recipes are expected diff --git a/qi/doc/qi.html b/qi/doc/qi.html index 526cf57b..dda08994 100644 --- a/qi/doc/qi.html +++ b/qi/doc/qi.html @@ -1,7 +1,7 @@ - + - Qi user guide @@ -22,6 +21,7 @@ Texts. A copy of the license is included in the section entitled + @@ -30,14 +30,23 @@ Texts. A copy of the license is included in the section entitled


-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

1 Introduction

- + +

1 Introduction

+ -

Qi is a simple but well-integrated package manager. It can creates, +

Qi is a simple but well-integrated package manager. It can create, install, remove, and upgrade software packages. Qi produces binary -packages using recipe names, these are files containing specific -instructions to build every source. Qi can manage multiple packages -under a single directory hierarchy, this method allows to maintain a set +packages using recipes, which are files containing specific instructions +to build each package from source. Qi can manage multiple packages +under a single directory hierarchy. This method allows to maintain a set of packages and multiple versions of them. This means that Qi could be used as the main package manager or complement the existing one.

-

Qi offers a friendly command line interface, a global configuration file, -a simple recipe layout to deploy software packages; also works with binary -packages in parallel, speeding up installations and packages in -production. The used format for packages is a simplified but safe POSIX -pax archive compressed with lzip. +

Qi offers a friendly command line interface, a global configuration +file, a simple recipe layout to deploy software packages; also works +with binary packages in parallel, speeding up installations and packages +in production. The format used for packages is a simplified but safe +POSIX pax archive compressed with lzip.

-

Qi is a modern (POSIX-compliant) shell script released under the terms of -the GNU General Public License. There are only two major dependencies for -the magic: graft(1) and tarlz(1), the rest is expected to be found in any -Unix-like system. +

Qi is a modern (POSIX-compliant) shell script released under the +terms of the GNU General Public License. There are only two major +dependencies for the magic: graft(1) and tarlz(1), the rest is expected +to be found in any Unix-like system.


-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

2 Invoking qi

- + +

2 Invoking qi

+

This chapter describes the synopsis and command line options for invoke Qi. @@ -220,7 +235,7 @@ performed.

-N

Do not read the configuration file.

-

This will omit any value on the qirc file. +

This will ignore any value in the qirc file.

-P <DIR>
@@ -249,8 +264,8 @@ pre-existing package.

-k
-

Keep (don’t delete) ‘${srcdir}’ or ‘${destdir}’ on build -mode, keep (don’t delete) package directory on delete mode. +

Keep (don’t delete) ‘${srcdir}’ or ‘${destdir}’ in build +mode, keep (don’t delete) package directory in delete mode.

Only valid for -b, -d or -u options.

@@ -277,7 +292,7 @@ to the specified directory, including the log file for graft.

-O <DIR>
-

Where the produced packages are written. +

Where the packages produced are written.

This option sets ‘${outdir}’.

@@ -320,7 +335,7 @@ to the specified directory, including the log file for graft.

Selects the option to skip completed recipes.

This means, in interactive mode, when the dialog -to summarize recipes is showed. +to summarize recipes is shown.

@@ -331,8 +346,8 @@ to summarize recipes is showed.

Print default directory locations.

This will print the target directory, package directory, working tree, -the directory for tarballs, and the output directory for produced -packages. +the directory for tarballs, and the output directory for the packages +produced.

-h
@@ -345,22 +360,24 @@ The version number should be included in all bug reports.

-

Expected arguments beyond of options are package directories and regular -files: recipes or files ending in .tlz, .order. When FILE is -, qi can -read from the standard input. See examples in Packages. +

Expected non-option arguments are package directories and regular files: +recipes or files ending in .tlz, .order. When FILE is -, qi can read from +the standard input. See examples in Packages.


-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

3 The qirc file

- + +

3 The qirc file

+

The global qirc file offers a way to define variables and tools (such as a download manager) for default use. This file is used by qi -at runtime for e.g to build, install, remove or upgrade packages. +at runtime, e.g., to build, install, remove or upgrade packages.

It has the following rules:

@@ -394,19 +411,21 @@ according to the $HOME.


-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

4 Packages

- + +

4 Packages

+

A package is a suite of programs usually distributed in binary form which may also contain manual pages, documentation, or any other file associated to a specific software.

The package format used by qi is a simplified POSIX pax archive -compressed with lzip. The file extension for packages ends in .tlz +compressed with lzip. The file extension for packages is ‘.tlz’.

Both package installation and package de-installation are managed using two important (internal) variables: ‘${packagedir}’ and @@ -421,16 +440,17 @@ made by graft(1) taking ‘${packagedir}/package_name’ in

Packages are installed in self-contained directory trees and symbolic links from a common area are made to the package files. This allows -multiple versions of the same package to co-exist on the one system. +multiple versions of the same package to coexist on the same system.

-

4.1 Package conflicts

- + +

4.1 Package conflicts

+

All the links to install or remove a package are handled by graft(1). Since multiple packages can be installed or removed at the same time, certain conflicts may arise between the packages.

-

graft1 +

graft1 defines a CONFLICT as one of the following conditions:

    @@ -450,8 +470,9 @@ graft(1) to remove those parts that are not in conflict, leaving the links to the belonging package. This behavior can be forced if the -p option is given.

    -

    4.2 Installing packages

    - + +

    4.2 Installing packages

    +

    To install a single package, simply type:

    @@ -508,13 +529,14 @@ system is able to see the recent lzip.

The list of packages must contain full path names to be passed in the -installation, e.g: +installation, e.g.: /var/cache/qi/packages/x86_64/devel/tcl-8.6.9-x86_64+1.tlz /var/cache/qi/packages/x86_64/devel/tk-8.6.9.1-x86_64+1.tlz /var/cache/qi/packages/x86_64/devel/vala-0.42.3-x86_64+1.tlz

-

4.3 Removing packages

- + +

4.3 Removing packages

+

To remove a package, simply type:

@@ -566,8 +588,9 @@ changed if the -k option is passed:

This will match with the package directory.

-

4.4 Upgrading packages

- + +

4.4 Upgrading packages

+

The upgrade mode inherits the properties of the installation and removal process. To make sure that a package is updated, the package is installed @@ -586,7 +609,7 @@ directory is removed.

This will proceed to update "gcc-9.0.1-i586+1" removing other versions of "gcc" (if any).

-

If you want to keep the package directory of found versions during the +

If you want to keep the package directories of versions found during the upgrade process, just pass:

@@ -607,47 +630,50 @@ upgrade process, just pass:
qi -u -f gcc-9.0.1-i586+1.tlz
 
-

4.4.1 Package blacklist

- + +

4.4.1 Package blacklist

+ -

To enforce general package facilities, either to install, remove or +

To implement general package facilities, either to install, remove or maintain the hierarchy of packages in a clean manner, qi makes use of the pruning operation via graft(1):

There is a risk if those are crucial packages for the proper functioning -of the system, because it implies to deactivate symbolic links from the +of the system, because it implies the deactivation of symbolic from the target directory, especially when transitioning an incoming package into its final location during upgrade.

-

A blacklist for declare package names has been devised for this cases, -in case that a user decides to upgrade all packages in the system or, +

A blacklist of package names has been devised for the case where +a user decides to upgrade all packages in the system, or just the crucial ones, such as the C library.

The blacklist is related to the upgrade mode only, consists in installing a package instead of updating it or removing previous versions of it; the content of the package will be updated over the existing content at ‘${packagedir}’, while the existing links from -‘${targetdir}’ will be preserved. A pruning of links will carried -out in order to re-link possible differences with the recent content, this -helps to avoid having dead links in the target directory. +‘${targetdir}’ will be preserved. A pruning of links will be +carried out in order to re-link possible differences with the recent +content, this helps to avoid leaving dead links in the target directory.

Since the upgrade mode is also used to install a new package, the mechanism for blacklist is to install a declared package if it does not already -exist, if it already exists, it is verified that the binary package is +exist. If it already exists, it is verified that the binary package is newer than the package directory in order to perform an update.

Package names for the blacklist can be set from the configuration file.


-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

5 Recipes

- + +

5 Recipes

+ -

A recipe is a file telling qi what to do. Most often, the recipe tells to +

A recipe is a file telling qi what to do. Most often, the recipe tells qi how to build a binary package from a source tarball.

A recipe has two parts: a list of variable definitions and a list of @@ -669,8 +695,9 @@ The section names or the function names currently recognized are section (or shell function) which contains the instructions to build and produce a package.

-

5.1 Variables

- + +

5.1 Variables

+

A "variable" is a shell variable defined either in qirc or in a recipe to represent a string of text, called the variable’s @@ -679,14 +706,14 @@ definitions of other variables or in calls to external commands.

Variables can represent lists of file names, options to pass to compilers, programs to run, directories to look in for source files, -directories to write output in, or anything else you can imagine. +directories to write output to, or anything else you can imagine.

Definitions of variables in qi have four levels of precedence. Options which define variables from the command-line override those specified in the qirc file, while variables defined in the recipe override those specified in qirc, taking priority over those -variables settled by options via command-line. Finally, the variables -have default values if they are not defined anywhere. +variables set by command-line options. Finally, the variables have +default values if they are not defined anywhere.

Options that set variables through the command-line can only reference variables defined in qirc and variables with default values. @@ -695,17 +722,18 @@ variables defined in qirc and variables with default values. previously defined in qirc and variables with default values.

Definitions of variables in the recipe can only reference variables -settled by command-line, variables previously defined in the recipe, +set by the command-line, variables previously defined in the recipe, variables defined in qirc, and variables with default values.

-

5.2 Special variables

- + +

5.2 Special variables

+

There are variables which can only be set using the command line options or via qirc, there are other special variables which can be defined or redefined in a recipe. See the following definitions:

-

outdir’ is the directory where the produced packages are written. +

outdir’ is the directory where the packages produced are written. This variable can not be redefined in the recipe. Default sets to ‘/var/cache/qi/packages’.

@@ -725,8 +753,8 @@ available in the recipe as ‘${arch}’. Default value is of ‘uname -m’.

jobs’ is the number of parallel jobs to pass to the compiler. Its -value is available in the recipe as ‘${jobs}’. Default sets to -‘1’. +value is available in the recipe as ‘${jobs}’. The default value +is 1.

The two variables ‘${srcdir}’ and ‘${destdir}’ can be set in the recipe, as any other variable, but if they are not, qi uses @@ -801,9 +829,10 @@ Long description. "

-

The first (substantial) line of the value is a brief description of the -software (called "blurb"). A newline follows to separate the brief -description from the long description. +

The first line of the value represented is a brief description of the +software (called "blurb"). A blank line separates the brief +description from the long description, it should contain a more +descriptive description of the software.

An example looks like:

@@ -827,7 +856,7 @@ one would be used on the meta file creation. See
homepage=http://www.gnu.org/software/gcc
 
-

The variable ‘license’ is used for license information2. +

The variable ‘license’ is used for license information2. Some code in the program can be covered by license A, license B, or license C. For "separate licensing" or "heterogeneous licensing", we suggest using | for a disjunction, & for a conjunction @@ -838,20 +867,22 @@ licensing. Comma would have lower precedence, plus added special terms.

license="LGPL, GPL | Artistic + added permission"
 
-

5.3 Writing recipes

- + +

5.3 Writing recipes

+

TO DO.

-

5.4 Building packages

- + +

5.4 Building packages

+ -

A recipe is any valid regular file, qi sets priorities to read a recipe, +

A recipe is any valid regular file. qi sets priorities to read a recipe, for example, the Current Working Directory has priority over the working tree (or where the recipes reside); the ‘${worktree}/recipes’ is -the second place where to find a recipe, we complete the possibility of -using the directory name to invoke a recipe if it contains "recipe" as a -valid file name. +the second place where qi searchs for a recipe. We complete the +possibility of using the directory name to invoke a recipe if it contains +"recipe" as a valid file name.

To build a single package, type:

@@ -859,13 +890,13 @@ valid file name.
qi -b x-apps/xterm
 
-

Multiple jobs can be passed to the compiler for speed up the build process: +

Multiple jobs can be passed to the compiler to speed up the build process:

qi -b -j3 x-apps/xterm
 
-

Update or install the produced package (if it is not already installed) +

Update or install the package produced (if it is not already installed) when finish:

@@ -888,23 +919,25 @@ when finish: directory for later inspection. A log file of the build process will be created redirecting both, standard error and standard output to tee(1).

-

5.5 Variables from the environment

- + +

5.5 Variables from the environment

+

Qi has environment variables which can be used at build time:

The variable TMPDIR sets the temporary directory for sources, which is -used for package extractions (see Examining packages) and to prepend -the value of ‘${srcdir}’ and ‘${destdir}’ on build mode. By -convention its default value is equal to ‘/usr/src/qi/build’. +used for package extractions (see Examining packages) and is +prepended to the value of ‘${srcdir}’ and ‘${destdir}’ in +build mode. By convention its default value is equal to +‘/usr/src/qi/build’.

The variables QICFLAGS, QICXXFLAGS, and QILDFLAGS have no effect by default. The environment variables such as CFLAGS, CXXFLAGS, and LDFLAGS are unset at compile time:

-

Recommended practices is to set variables in front of ‘configure’ -or in front of make(1) instead of exporting to the environment. -As follows: +

Recommended practice is to set variables in the command line of +‘configure’ or make(1) instead of exporting to the +environment. As follows:

Variables not defined in a site shell script can be set in the environment @@ -940,14 +973,15 @@ against the whole purpose of most makefiles.

http://gnu.org/software/make/manual/make.html#Environment

-

5.6 The meta file

- + +

5.6 The meta file

+

The "meta file" is a regular file created during the build mode, it contains information about the package such as program name, program version, release, fetch address, description, and other minor data extracted from processed recipes. The name of the file is generated as -‘${full_pkgname}.tlz.txt’, it has the purpose to reflect essential +‘${full_pkgname}.tlz.txt’, and its purpose is to reflect essential information to the user without having to look inside the package content.

The content of a meta file looks like: @@ -991,14 +1025,16 @@ line of ‘description’, mentioned as the "brief des


-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

6 Order files

- + +

6 Order files

+ -

The order mode has the purpose to resolve the build order through +

The order mode has the purpose of resolving the build order through .order files. An order file contains a list of recipe names, by default does not perform any action other than to print a resolved list in descending order. For example, if a depends on b and @@ -1023,11 +1059,11 @@ c a

-

Declaration of blank lines, colons, parentheses, and end of line are -simply ignored. Comments are allowed for lines that begin with ‘#’. +

Blank lines, colons and parentheses are simply ignored. Comment lines +beginning with ‘#’ are allowed.

-

An order file could be used to build a serie of packages, for example, if -the content is: +

An order file could be used to build a series of packages, for example, +if the content is:

# Image handling libraries
@@ -1055,25 +1091,27 @@ libs/tiff
 
 
 
-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

7 Creating packages

- + +

7 Creating packages

+

The "creation mode" is an internal function of qi to make new Qi compatible -packages, the creation mode is available through the -c option. A package -is produced using the contents of the Current Directory, finally the -package is written out to the file name. +compatible packages, the creation mode is selected by the -c option. +A package is produced using the contents of the Current Directory, and +the package file is written out.

Usage: qi -c [OUTPUT/packagename.tlz]...
 

The argument for the file name to be written must contain a fully -qualified named directory as the output directory where the produced -package will be written. The file name should be composed using the +qualified named directory as the output directory where the package +produced will be written. The file name should be composed using the full name: name-version-architecture+release.tlz

EXAMPLE @@ -1087,21 +1125,23 @@ qi -c /var/cache/qi/packages/x86_64/local/claws-mail-3.17.1-x86_64+1.tlz

In this case, the package "claws-mail-3.17.1-x86_64+1.tlz" will be written into ‘/var/cache/qi/packages/x86_64/local/’.

-

All produced packages are complemented by a checksum file (.sha256). +

All packages produced are complemented by a checksum file (.sha256).


-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

8 Examining packages

- + +

8 Examining packages

+

The "extraction mode" serves to examine binary packages for debugging -purposes, the extraction mode is available through the -x option. It -consists of decompressing a package into a single directory, verifying -its integrity and preserving its properties. +purposes. The extraction mode is selected by the -x option. It +decompresses a package into a single directory, verifying its integrity +and preserving its properties.

Usage: qi -x [packagename.tlz]...
@@ -1115,9 +1155,10 @@ its integrity and preserving its properties.
 
 

This action will put the content of "mksh-R56c-x86_64+1.tlz" into a single directory, this will be a private directory for the user who -requested the action, creation mode will be equal to -u=,g=rwx,o=rwx (0700). The package content will reside on -this location, default mask to deploy the content will be equal to +

+

requested the action, creation mode will be equal to u=rwx,g=,o= +(0700). The package content will reside on this location, default +mask to deploy the content will be equal to u=rwx,g=rwx,o=rwx (0000).

The creation of the custom directory is influenced by the value of the @@ -1125,14 +1166,16 @@ this location, default mask to deploy the content will be equal to


-
+ +

Next: , Previous: , Up: Top   [Contents][Index]

-

9 Exit status

- + +

9 Exit status

+ -

All the conditions of exit codes are described in this chapter. +

All the exit codes are described in this chapter.

0
@@ -1166,7 +1209,7 @@ arguments in case of error. Supported extensions: .tar, .tar.gz, .tgz, .tar.Z, .tar.bz2, .tbz2, .tbz, .tar.xz, .txz -
  • - Tarballs files from tarlz(1). +
  • - Tarball files from tarlz(1). Supported extensions: .tar.lz, .tlz
  • - Zip files from unzip(1). @@ -1218,7 +1261,7 @@ variables coming from a recipe or assigned arrays that are tested.
    6

    Package already installed:

    -

    The package directory for an incoming .tlz package that already exists. +

    The package directory for an incoming .tlz package already exists.

    10
    @@ -1230,11 +1273,13 @@ variables coming from a recipe or assigned arrays that are tested.
    -
    + +

    Next: , Previous: , Up: Top   [Contents][Index]

    -

    Appendix A GNU Free Documentation License

    + +

    Appendix A GNU Free Documentation License

    Version 1.3, 3 November 2008
    @@ -1247,7 +1292,7 @@ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
  • -
      +
      1. PREAMBLE

        The purpose of this License is to make a manual, textbook, or other @@ -1423,7 +1468,7 @@ Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

        -
          +
          1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section @@ -1669,14 +1714,15 @@ provided the MMC is eligible for relicensing.

          -

          ADDENDUM: How to use this License for your documents

          + +

          ADDENDUM: How to use this License for your documents

          To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

          -
          -
            Copyright (C)  year  your name.
          +
          +
            Copyright (C)  year  your name.
             Permission is granted to copy, distribute and/or modify this document
             under the terms of the GNU Free Documentation License, Version 1.3
             or any later version published by the Free Software Foundation;
          @@ -1688,8 +1734,8 @@ license notices just after the title page:
           

          If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:

          -
          -
              with the Invariant Sections being list their titles, with
          +
          +
              with the Invariant Sections being list their titles, with
               the Front-Cover Texts being list, and with the Back-Cover Texts
               being list.
           
          @@ -1706,11 +1752,13 @@ to permit their use in free software.
          -
          + +

          Previous: , Up: Top   [Contents][Index]

          -

          Index

          + +

          Index

          - + - + - + - + - + - + @@ -1765,19 +1813,19 @@ Previous: , Up: package installation: - + - + - + - + - +
          Jump to:   C   @@ -1738,24 +1786,24 @@ Previous: , Up:
          Index Entry  Section

          C
          C
          configuration file: The qirc file

          E
          E
          environment variables: Recipes
          exit codes: Exit status

          H
          H
          handling build order: Order files

          I
          I
          introduction: Introduction
          invocation: Invoking qi

          M
          M
          managing packages: Packages

          P
          P
          package blacklist: Packages
          package build: Recipes
          package conflicts: Packages
           Packages
          package upgrade: Packages

          R
          R
          recipes: Recipes

          S
          S
          special variables: Recipes

          T
          T
          the meta file: Recipes

          V
          V
          variables: Recipes

          W
          W
          writing recipes: Recipes

          @@ -1809,10 +1857,10 @@ Previous: , Up: Footnotes -

          (1)

          +

          (1)

          The official guide for Graft can be found at http://peters.gormand.com.au/Home/tools/graft/graft.html.

          -

          (2)

          +

          (2)

          The proposal for ‘license’ was made by Richard M. Stallman at http://lists.gnu.org/archive/html/gnu-linux-libre/2016-05/msg00003.html.

          diff --git a/qi/doc/qi.info b/qi/doc/qi.info index 1b3331e3..f12a33e8 100644 --- a/qi/doc/qi.info +++ b/qi/doc/qi.info @@ -1,6 +1,6 @@ -This is qi.info, produced by makeinfo version 6.6 from qi.texi. +This is qi.info, produced by makeinfo version 6.1 from qi.texi. -This user guide is for Qi (version 1.0-rc59, 2 April 2019), which is a +This user guide is for Qi (version 1.0-rc59, 4 April 2019), which is a simple but well-integrated package manager. Copyright © 2019 Matias Andres Fonzo, Santiago del Estero, Argentina. @@ -22,7 +22,7 @@ File: qi.info, Node: Top, Next: Introduction, Up: (dir) Qi user guide ************* -This user guide is for Qi (version 1.0-rc59, 2 April 2019). +This user guide is for Qi (version 1.0-rc59, 4 April 2019). * Menu: @@ -50,18 +50,18 @@ File: qi.info, Node: Introduction, Next: Invoking qi, Prev: Top, Up: Top 1 Introduction ************** -Qi is a simple but well-integrated package manager. It can creates, +Qi is a simple but well-integrated package manager. It can create, install, remove, and upgrade software packages. Qi produces binary -packages using recipe names, these are files containing specific -instructions to build every source. Qi can manage multiple packages -under a single directory hierarchy, this method allows to maintain a set -of packages and multiple versions of them. This means that Qi could be -used as the main package manager or complement the existing one. +packages using recipes, which are files containing specific instructions +to build each package from source. Qi can manage multiple packages +under a single directory hierarchy. This method allows to maintain a +set of packages and multiple versions of them. This means that Qi could +be used as the main package manager or complement the existing one. Qi offers a friendly command line interface, a global configuration file, a simple recipe layout to deploy software packages; also works with binary packages in parallel, speeding up installations and packages -in production. The used format for packages is a simplified but safe +in production. The format used for packages is a simplified but safe POSIX pax archive compressed with lzip. Qi is a modern (POSIX-compliant) shell script released under the @@ -115,7 +115,7 @@ There are common options between modes: '-N' Do not read the configuration file. - This will omit any value on the qirc file. + This will ignore any value in the qirc file. '-P ' Package directory for installations. @@ -140,8 +140,8 @@ There are common options between modes: Only valid for -i, -d, or -u options. '-k' - Keep (don't delete) '${srcdir}' or '${destdir}' on build mode, keep - (don't delete) package directory on delete mode. + Keep (don't delete) '${srcdir}' or '${destdir}' in build mode, keep + (don't delete) package directory in delete mode. Only valid for -b, -d or -u options. @@ -163,7 +163,7 @@ There are common options between modes: Options for build mode (-b): '-O ' - Where the produced packages are written. + Where the packages produced are written. This option sets '${outdir}'. @@ -199,7 +199,7 @@ Options for build mode (-b): Selects the option to skip completed recipes. This means, in interactive mode, when the dialog to summarize - recipes is showed. + recipes is shown. Informative options: @@ -207,8 +207,8 @@ Informative options: Print default directory locations. This will print the target directory, package directory, working - tree, the directory for tarballs, and the output directory for - produced packages. + tree, the directory for tarballs, and the output directory for the + packages produced. '-h' Display the help describing the options and then exit. @@ -217,9 +217,9 @@ Informative options: Print the version number and license information. The version number should be included in all bug reports. -Expected arguments beyond of options are package directories and regular -files: recipes or files ending in .tlz, .order. When FILE is -, qi can -read from the standard input. See examples in *note Packages::. +Expected non-option arguments are package directories and regular files: +recipes or files ending in .tlz, .order. When FILE is -, qi can read +from the standard input. See examples in *note Packages::.  File: qi.info, Node: The qirc file, Next: Packages, Prev: Invoking qi, Up: Top @@ -229,7 +229,7 @@ File: qi.info, Node: The qirc file, Next: Packages, Prev: Invoking qi, Up: T The global 'qirc' file offers a way to define variables and tools (such as a download manager) for default use. This file is used by qi at -runtime for e.g to build, install, remove or upgrade packages. +runtime, e.g., to build, install, remove or upgrade packages. It has the following rules: @@ -265,7 +265,7 @@ which may also contain manual pages, documentation, or any other file associated to a specific software. The package format used by qi is a simplified POSIX pax archive -compressed with lzip. The file extension for packages ends in .tlz +compressed with lzip. The file extension for packages is '.tlz'. Both package installation and package de-installation are managed using two important (internal) variables: '${packagedir}' and '${targetdir}', @@ -279,7 +279,7 @@ graft(1) taking '${packagedir}/package_name' into account. Packages are installed in self-contained directory trees and symbolic links from a common area are made to the package files. This allows -multiple versions of the same package to co-exist on the one system. +multiple versions of the same package to coexist on the same system. 4.1 Package conflicts ===================== @@ -350,7 +350,7 @@ Installing from a list of packages using standard input: cat FILELIST.txt | qi -i - The list of packages must contain full path names to be passed in the -installation, e.g: +installation, e.g.: /var/cache/qi/packages/x86_64/devel/tcl-8.6.9-x86_64+1.tlz /var/cache/qi/packages/x86_64/devel/tk-8.6.9.1-x86_64+1.tlz /var/cache/qi/packages/x86_64/devel/vala-0.42.3-x86_64+1.tlz @@ -412,7 +412,7 @@ To upgrade a package, just type: This will proceed to update "gcc-9.0.1-i586+1" removing other versions of "gcc" (if any). -If you want to keep the package directory of found versions during the +If you want to keep the package directories of versions found during the upgrade process, just pass: qi -u -k gcc-9.0.1-i586+1.tlz @@ -430,30 +430,30 @@ To force the upgrade of an existing package: 4.4.1 Package blacklist ----------------------- -To enforce general package facilities, either to install, remove or +To implement general package facilities, either to install, remove or maintain the hierarchy of packages in a clean manner, qi makes use of the pruning operation via graft(1): There is a risk if those are crucial packages for the proper -functioning of the system, because it implies to deactivate symbolic -links from the target directory, _especially_ when transitioning an +functioning of the system, because it implies the deactivation of +symbolic from the target directory, _especially_ when transitioning an incoming package into its final location during upgrade. -A blacklist for declare package names has been devised for this cases, -in case that a user decides to upgrade all packages in the system or, -just the crucial ones, such as the C library. +A blacklist of package names has been devised for the case where a user +decides to upgrade all packages in the system, or just the crucial ones, +such as the C library. The blacklist is related to the upgrade mode only, consists in installing a package instead of updating it or removing previous versions of it; the content of the package will be updated over the existing content at '${packagedir}', while the existing links from -'${targetdir}' will be preserved. A pruning of links will carried out -in order to re-link possible differences with the recent content, this -helps to avoid having dead links in the target directory. +'${targetdir}' will be preserved. A pruning of links will be carried +out in order to re-link possible differences with the recent content, +this helps to avoid leaving dead links in the target directory. Since the upgrade mode is also used to install a new package, the mechanism for blacklist is to install a declared package if it does not -already exist, if it already exists, it is verified that the binary +already exist. If it already exists, it is verified that the binary package is newer than the package directory in order to perform an update. @@ -472,7 +472,7 @@ File: qi.info, Node: Recipes, Next: Order files, Prev: Packages, Up: Top ********* A recipe is a file telling qi what to do. Most often, the recipe tells -to qi how to build a binary package from a source tarball. +qi how to build a binary package from a source tarball. A recipe has two parts: a list of variable definitions and a list of sections. By convention, the syntax of a section is: @@ -501,14 +501,14 @@ other variables or in calls to external commands. Variables can represent lists of file names, options to pass to compilers, programs to run, directories to look in for source files, -directories to write output in, or anything else you can imagine. +directories to write output to, or anything else you can imagine. Definitions of variables in qi have four levels of precedence. Options which define variables from the command-line override those specified in the 'qirc' file, while variables defined in the recipe override those specified in 'qirc', taking priority over those variables -settled by options via command-line. Finally, the variables have -default values if they are not defined anywhere. +set by command-line options. Finally, the variables have default values +if they are not defined anywhere. Options that set variables through the command-line can only reference variables defined in 'qirc' and variables with default values. @@ -517,7 +517,7 @@ reference variables defined in 'qirc' and variables with default values. previously defined in 'qirc' and variables with default values. Definitions of variables in the recipe can only reference variables -settled by command-line, variables previously defined in the recipe, +set by the command-line, variables previously defined in the recipe, variables defined in 'qirc', and variables with default values. 5.2 Special variables @@ -527,7 +527,7 @@ There are variables which can only be set using the command line options or via 'qirc', there are other special variables which can be defined or redefined in a recipe. See the following definitions: - 'outdir' is the directory where the produced packages are written. + 'outdir' is the directory where the packages produced are written. This variable can not be redefined in the recipe. Default sets to '/var/cache/qi/packages'. @@ -546,7 +546,7 @@ available in the recipe as '${arch}'. Default value is the output of 'uname -m'. 'jobs' is the number of parallel jobs to pass to the compiler. Its -value is available in the recipe as '${jobs}'. Default sets to '1'. +value is available in the recipe as '${jobs}'. The default value is 1. The two variables '${srcdir}' and '${destdir}' can be set in the recipe, as any other variable, but if they are not, qi uses default @@ -615,9 +615,10 @@ description. By convention, the syntax of 'description' is: Long description. " - The first (substantial) line of the value is a brief description of -the software (called "blurb"). A newline follows to separate the _brief -description_ from the _long description_. + The first line of the value represented is a brief description of the +software (called "blurb"). A blank line separates the _brief +description_ from the _long description_, it should contain a more +descriptive description of the software. An example looks like: @@ -655,23 +656,23 @@ TO DO. 5.4 Building packages ===================== -A recipe is any valid regular file, qi sets priorities to read a recipe, -for example, the Current Working Directory has priority over the working -tree (or where the recipes reside); the '${worktree}/recipes' is the -second place where to find a recipe, we complete the possibility of -using the directory name to invoke a recipe if it contains "recipe" as a -valid file name. +A recipe is any valid regular file. qi sets priorities to read a +recipe, for example, the Current Working Directory has priority over the +working tree (or where the recipes reside); the '${worktree}/recipes' is +the second place where qi searchs for a recipe. We complete the +possibility of using the directory name to invoke a recipe if it +contains "recipe" as a valid file name. To build a single package, type: qi -b x-apps/xterm -Multiple jobs can be passed to the compiler for speed up the build +Multiple jobs can be passed to the compiler to speed up the build process: qi -b -j3 x-apps/xterm -Update or install the produced package (if it is not already installed) +Update or install the package produced (if it is not already installed) when finish: qi -b -j3 -u x-apps/xterm @@ -696,16 +697,17 @@ created redirecting both, standard error and standard output to tee(1). Qi has environment variables which can be used at build time: The variable 'TMPDIR' sets the temporary directory for sources, which -is used for package extractions (see *note Examining packages::) and to -prepend the value of '${srcdir}' and '${destdir}' on build mode. By -convention its default value is equal to '/usr/src/qi/build'. +is used for package extractions (see *note Examining packages::) and is +prepended to the value of '${srcdir}' and '${destdir}' in build mode. +By convention its default value is equal to '/usr/src/qi/build'. The variables 'QICFLAGS', 'QICXXFLAGS', and 'QILDFLAGS' have no effect by default. The environment variables such as 'CFLAGS', 'CXXFLAGS', and 'LDFLAGS' are unset at compile time: -Recommended practices is to set variables in front of 'configure' or in -front of _make(1)_ instead of exporting to the environment. As follows: +Recommended practice is to set variables in the command line of +'configure' or _make(1)_ instead of exporting to the environment. As +follows: Variables not defined in a site shell script can be set in the environment passed to configure. However, some packages may run @@ -744,7 +746,7 @@ The "meta file" is a regular file created during the build mode, it contains information about the package such as program name, program version, release, fetch address, description, and other minor data extracted from processed recipes. The name of the file is generated as -'${full_pkgname}.tlz.txt', it has the purpose to reflect essential +'${full_pkgname}.tlz.txt', and its purpose is to reflect essential information to the user without having to look inside the package content. @@ -796,11 +798,11 @@ File: qi.info, Node: Order files, Next: Creating packages, Prev: Recipes, Up 6 Order files ************* -The order mode has the purpose to resolve the build order through .order -files. An order file contains a list of recipe names, by default does -not perform any action other than to print a resolved list in descending -order. For example, if *a* depends on *b* and *c*, and *c* depends on -*b* as well, the file might look like: +The order mode has the purpose of resolving the build order through +.order files. An order file contains a list of recipe names, by default +does not perform any action other than to print a resolved list in +descending order. For example, if *a* depends on *b* and *c*, and *c* +depends on *b* as well, the file might look like: a: c b b: @@ -816,10 +818,10 @@ right to left, and removed from left to right: c a - Declaration of blank lines, colons, parentheses, and end of line are -simply ignored. Comments are allowed for lines that begin with '#'. + Blank lines, colons and parentheses are simply ignored. Comment +lines beginning with '#' are allowed. -An order file could be used to build a serie of packages, for example, +An order file could be used to build a series of packages, for example, if the content is: # Image handling libraries @@ -847,15 +849,15 @@ File: qi.info, Node: Creating packages, Next: Examining packages, Prev: Order ******************* The "creation mode" is an internal function of qi to make new Qi -compatible packages, the creation mode is available through the -c +compatible compatible packages, the creation mode is selected by the -c option. A package is produced using the contents of the Current -Directory, finally the package is written out to the file name. +Directory, and the package file is written out. Usage: qi -c [OUTPUT/PACKAGENAME.TLZ]... The argument for the file name to be written must contain a fully -qualified named directory as the output directory where the produced -package will be written. The file name should be composed using the +qualified named directory as the output directory where the package +produced will be written. The file name should be composed using the full name: name-version-architecture+release.tlz EXAMPLE @@ -867,7 +869,7 @@ full name: name-version-architecture+release.tlz In this case, the package "claws-mail-3.17.1-x86_64+1.tlz" will be written into '/var/cache/qi/packages/x86_64/local/'. -All produced packages are complemented by a checksum file (.sha256). +All packages produced are complemented by a checksum file (.sha256).  File: qi.info, Node: Examining packages, Next: Exit status, Prev: Creating packages, Up: Top @@ -876,9 +878,9 @@ File: qi.info, Node: Examining packages, Next: Exit status, Prev: Creating pa ******************** The "extraction mode" serves to examine binary packages for debugging -purposes, the extraction mode is available through the -x option. It -consists of decompressing a package into a single directory, verifying -its integrity and preserving its properties. +purposes. The extraction mode is selected by the -x option. It +decompresses a package into a single directory, verifying its integrity +and preserving its properties. Usage: qi -x [PACKAGENAME.TLZ]... @@ -888,7 +890,8 @@ its integrity and preserving its properties. This action will put the content of "mksh-R56c-x86_64+1.tlz" into a single directory, this will be a private directory for the user who -requested the action, creation mode will be equal to *u=,g=rwx,o=rwx + + requested the action, creation mode will be equal to *u=rwx,g=,o= (0700)*. The package content will reside on this location, default mask to deploy the content will be equal to *u=rwx,g=rwx,o=rwx (0000)*. @@ -901,7 +904,7 @@ File: qi.info, Node: Exit status, Next: License, Prev: Examining packages, U 9 Exit status ************* -All the conditions of exit codes are described in this chapter. +All the exit codes are described in this chapter. '0' Successful completion (no errors). @@ -927,7 +930,7 @@ All the conditions of exit codes are described in this chapter. - Tarball files from tar(1). Supported extensions: .tar, .tar.gz, .tgz, .tar.Z, .tar.bz2, .tbz2, .tbz, .tar.xz, .txz - - Tarballs files from tarlz(1). Supported extensions: .tar.lz, + - Tarball files from tarlz(1). Supported extensions: .tar.lz, .tlz - Zip files from unzip(1). Supported extensions: .zip, .ZIP @@ -968,8 +971,7 @@ All the conditions of exit codes are described in this chapter. '6' Package already installed: - The package directory for an incoming .tlz package that already - exists. + The package directory for an incoming .tlz package already exists. '10' Network manager error: @@ -1469,14 +1471,14 @@ Index * Menu: * configuration file: The qirc file. (line 6) -* environment variables: Recipes. (line 228) +* environment variables: Recipes. (line 229) * exit codes: Exit status. (line 6) * handling build order: Order files. (line 6) * introduction: Introduction. (line 6) * invocation: Invoking qi. (line 6) * managing packages: Packages. (line 6) * package blacklist: Packages. (line 176) -* package build: Recipes. (line 190) +* package build: Recipes. (line 191) * package conflicts: Packages. (line 30) * package creation: Creating packages. (line 6) * package de-installation: Packages. (line 104) @@ -1485,27 +1487,27 @@ Index * package upgrade: Packages. (line 143) * recipes: Recipes. (line 6) * special variables: Recipes. (line 58) -* the meta file: Recipes. (line 275) +* the meta file: Recipes. (line 277) * variables: Recipes. (line 29) -* writing recipes: Recipes. (line 185) +* writing recipes: Recipes. (line 186)  Tag Table: Node: Top804 Node: Introduction1646 -Node: Invoking qi2808 -Node: The qirc file6228 -Node: Packages7306 -Ref: Packages-Footnote-114353 -Node: Recipes14466 -Ref: Recipes-Footnote-126568 -Node: Order files26713 -Node: Creating packages28047 -Node: Examining packages29098 -Node: Exit status30025 -Node: License31990 -Node: Index57106 +Node: Invoking qi2815 +Node: The qirc file6233 +Node: Packages7310 +Ref: Packages-Footnote-114346 +Node: Recipes14459 +Ref: Recipes-Footnote-126620 +Node: Order files26765 +Node: Creating packages28067 +Node: Examining packages29107 +Node: Exit status30017 +Node: License31957 +Node: Index57073  End Tag Table diff --git a/qi/doc/qi.texi b/qi/doc/qi.texi index cefbeaec..d0dc5021 100644 --- a/qi/doc/qi.texi +++ b/qi/doc/qi.texi @@ -8,7 +8,7 @@ @comment %**end of header @set VERSION 1.0-rc59 -@set UPDATED 2 April 2019 +@set UPDATED 4 April 2019 @copying This user guide is for Qi (version @value{VERSION}, @@ -77,24 +77,24 @@ Qi's home page can be found at @uref{http://www.dragora.org}. @chapter Introduction @cindex introduction -Qi is a simple but well-integrated package manager. It can creates, +Qi is a simple but well-integrated package manager. It can create, install, remove, and upgrade software packages. Qi produces binary -packages using recipe names, these are files containing specific -instructions to build every source. Qi can manage multiple packages -under a single directory hierarchy, this method allows to maintain a set +packages using recipes, which are files containing specific instructions +to build each package from source. Qi can manage multiple packages +under a single directory hierarchy. This method allows to maintain a set of packages and multiple versions of them. This means that Qi could be used as the main package manager or complement the existing one. -Qi offers a friendly command line interface, a global configuration file, -a simple recipe layout to deploy software packages; also works with binary -packages in parallel, speeding up installations and packages in -production. The used format for packages is a simplified but safe POSIX -pax archive compressed with lzip. +Qi offers a friendly command line interface, a global configuration +file, a simple recipe layout to deploy software packages; also works +with binary packages in parallel, speeding up installations and packages +in production. The format used for packages is a simplified but safe +POSIX pax archive compressed with lzip. -Qi is a modern (POSIX-compliant) shell script released under the terms of -the GNU General Public License. There are only two major dependencies for -the magic: graft(1) and tarlz(1), the rest is expected to be found in any -Unix-like system. +Qi is a modern (POSIX-compliant) shell script released under the +terms of the GNU General Public License. There are only two major +dependencies for the magic: graft(1) and tarlz(1), the rest is expected +to be found in any Unix-like system. @node Invoking qi @chapter Invoking qi @@ -148,7 +148,7 @@ There are common options between modes: @item -N Do not read the configuration file. -This will omit any value on the qirc file. +This will ignore any value in the qirc file. @item -P Package directory for installations. @@ -173,8 +173,8 @@ This option sets @samp{$@{targetdir@}}. Only valid for -i, -d, or -u options. @item -k -Keep (don't delete) @samp{$@{srcdir@}} or @samp{$@{destdir@}} on build -mode, keep (don't delete) package directory on delete mode. +Keep (don't delete) @samp{$@{srcdir@}} or @samp{$@{destdir@}} in build +mode, keep (don't delete) package directory in delete mode. Only valid for -b, -d or -u options. @@ -198,7 +198,7 @@ Options for build mode (-b): @table @code @item -O -Where the produced packages are written. +Where the packages produced are written. This option sets @samp{$@{outdir@}}. @@ -234,7 +234,7 @@ Don't create a .tlz package. Selects the option to skip completed recipes. This means, in interactive mode, when the dialog -to summarize recipes is showed. +to summarize recipes is shown. @end table @noindent @@ -245,8 +245,8 @@ Informative options: Print default directory locations. This will print the target directory, package directory, working tree, -the directory for tarballs, and the output directory for produced -packages. +the directory for tarballs, and the output directory for the packages +produced. @item -h Display the help describing the options and then exit. @@ -257,9 +257,9 @@ The version number should be included in all bug reports. @end table @noindent -Expected arguments beyond of options are package directories and regular -files: recipes or files ending in .tlz, .order. When FILE is -, qi can -read from the standard input. See examples in @ref{Packages}. +Expected non-option arguments are package directories and regular files: +recipes or files ending in .tlz, .order. When FILE is -, qi can read from +the standard input. See examples in @ref{Packages}. @node The qirc file @@ -268,7 +268,7 @@ read from the standard input. See examples in @ref{Packages}. The global @file{qirc} file offers a way to define variables and tools (such as a download manager) for default use. This file is used by qi -at runtime for e.g to build, install, remove or upgrade packages. +at runtime, e.g., to build, install, remove or upgrade packages. @noindent It has the following rules: @@ -315,7 +315,7 @@ which may also contain manual pages, documentation, or any other file associated to a specific software. The package format used by qi is a simplified POSIX pax archive -compressed with lzip. The file extension for packages ends in .tlz +compressed with lzip. The file extension for packages is @samp{.tlz}. @noindent Both package installation and package de-installation are managed using @@ -332,7 +332,7 @@ made by graft(1) taking @samp{$@{packagedir@}/package_name} into account. @noindent Packages are installed in self-contained directory trees and symbolic links from a common area are made to the package files. This allows -multiple versions of the same package to co-exist on the one system. +multiple versions of the same package to coexist on the same system. @section Package conflicts @cindex package conflicts @@ -430,7 +430,7 @@ cat FILELIST.txt | qi -i - @end example The list of packages must contain full path names to be passed in the -installation, e.g: +installation, e.g.: /var/cache/qi/packages/x86_64/devel/tcl-8.6.9-x86_64+1.tlz /var/cache/qi/packages/x86_64/devel/tk-8.6.9.1-x86_64+1.tlz /var/cache/qi/packages/x86_64/devel/vala-0.42.3-x86_64+1.tlz @@ -515,7 +515,7 @@ This will proceed to update "gcc-9.0.1-i586+1" removing other versions of "gcc" (if any). @noindent -If you want to keep the package directory of found versions during the +If you want to keep the package directories of versions found during the upgrade process, just pass: @example @@ -541,32 +541,32 @@ qi -u -f gcc-9.0.1-i586+1.tlz @subsection Package blacklist @cindex package blacklist -To enforce general package facilities, either to install, remove or +To implement general package facilities, either to install, remove or maintain the hierarchy of packages in a clean manner, qi makes use of the pruning operation via graft(1): There is a risk if those are crucial packages for the proper functioning -of the system, because it implies to deactivate symbolic links from the +of the system, because it implies the deactivation of symbolic from the target directory, @emph{especially} when transitioning an incoming package into its final location during upgrade. @noindent -A blacklist for declare package names has been devised for this cases, -in case that a user decides to upgrade all packages in the system or, +A blacklist of package names has been devised for the case where +a user decides to upgrade all packages in the system, or just the crucial ones, such as the C library. The blacklist is related to the upgrade mode only, consists in installing a package instead of updating it or removing previous versions of it; the content of the package will be updated over the existing content at @samp{$@{packagedir@}}, while the existing links from -@samp{$@{targetdir@}} will be preserved. A pruning of links will carried -out in order to re-link possible differences with the recent content, this -helps to avoid having dead links in the target directory. +@samp{$@{targetdir@}} will be preserved. A pruning of links will be +carried out in order to re-link possible differences with the recent +content, this helps to avoid leaving dead links in the target directory. @noindent Since the upgrade mode is also used to install a new package, the mechanism for blacklist is to install a declared package if it does not already -exist, if it already exists, it is verified that the binary package is +exist. If it already exists, it is verified that the binary package is newer than the package directory in order to perform an update. Package names for the blacklist can be set from the configuration file. @@ -576,7 +576,7 @@ Package names for the blacklist can be set from the configuration file. @chapter Recipes @cindex recipes -A recipe is a file telling qi what to do. Most often, the recipe tells to +A recipe is a file telling qi what to do. Most often, the recipe tells qi how to build a binary package from a source tarball. A recipe has two parts: a list of variable definitions and a list of @@ -608,14 +608,14 @@ definitions of other variables or in calls to external commands. Variables can represent lists of file names, options to pass to compilers, programs to run, directories to look in for source files, -directories to write output in, or anything else you can imagine. +directories to write output to, or anything else you can imagine. Definitions of variables in qi have four levels of precedence. Options which define variables from the command-line override those specified in the @file{qirc} file, while variables defined in the recipe override those specified in @file{qirc}, taking priority over those -variables settled by options via command-line. Finally, the variables -have default values if they are not defined anywhere. +variables set by command-line options. Finally, the variables have +default values if they are not defined anywhere. Options that set variables through the command-line can only reference variables defined in @file{qirc} and variables with default values. @@ -624,7 +624,7 @@ Definitions of variables in @file{qirc} can only reference variables previously defined in @file{qirc} and variables with default values. Definitions of variables in the recipe can only reference variables -settled by command-line, variables previously defined in the recipe, +set by the command-line, variables previously defined in the recipe, variables defined in @file{qirc}, and variables with default values. @section Special variables @@ -634,7 +634,7 @@ There are variables which can only be set using the command line options or via @file{qirc}, there are other special variables which can be defined or redefined in a recipe. See the following definitions: -@samp{outdir} is the directory where the produced packages are written. +@samp{outdir} is the directory where the packages produced are written. This variable can not be redefined in the recipe. Default sets to @samp{/var/cache/qi/packages}. @@ -654,8 +654,8 @@ available in the recipe as @samp{$@{arch@}}. Default value is the output of @samp{uname -m}. @samp{jobs} is the number of parallel jobs to pass to the compiler. Its -value is available in the recipe as @samp{$@{jobs@}}. Default sets to -@samp{1}. +value is available in the recipe as @samp{$@{jobs@}}. The default value +is 1. The two variables @samp{$@{srcdir@}} and @samp{$@{destdir@}} can be set in the recipe, as any other variable, but if they are not, qi uses @@ -732,9 +732,10 @@ Long description. " @end example -The first (substantial) line of the value is a brief description of the -software (called "blurb"). A newline follows to separate the @emph{brief -description} from the @emph{long description}. +The first line of the value represented is a brief description of the +software (called "blurb"). A blank line separates the @emph{brief +description} from the @emph{long description}, it should contain a more +descriptive description of the software. @noindent An example looks like: @@ -780,12 +781,12 @@ TO DO. @section Building packages @cindex package build -A recipe is any valid regular file, qi sets priorities to read a recipe, +A recipe is any valid regular file. qi sets priorities to read a recipe, for example, the Current Working Directory has priority over the working tree (or where the recipes reside); the @samp{$@{worktree@}/recipes} is -the second place where to find a recipe, we complete the possibility of -using the directory name to invoke a recipe if it contains "recipe" as a -valid file name. +the second place where qi searchs for a recipe. We complete the +possibility of using the directory name to invoke a recipe if it contains +"recipe" as a valid file name. @noindent To build a single package, type: @@ -795,14 +796,14 @@ qi -b x-apps/xterm @end example @noindent -Multiple jobs can be passed to the compiler for speed up the build process: +Multiple jobs can be passed to the compiler to speed up the build process: @example qi -b -j3 x-apps/xterm @end example @noindent -Update or install the produced package (if it is not already installed) +Update or install the package produced (if it is not already installed) when finish: @example @@ -833,18 +834,19 @@ created redirecting both, standard error and standard output to tee(1). Qi has environment variables which can be used at build time: The variable @env{TMPDIR} sets the temporary directory for sources, which is -used for package extractions (see @ref{Examining packages}) and to prepend -the value of @samp{$@{srcdir@}} and @samp{$@{destdir@}} on build mode. By -convention its default value is equal to @samp{/usr/src/qi/build}. +used for package extractions (see @ref{Examining packages}) and is +prepended to the value of @samp{$@{srcdir@}} and @samp{$@{destdir@}} in +build mode. By convention its default value is equal to +@samp{/usr/src/qi/build}. The variables @env{QICFLAGS}, @env{QICXXFLAGS}, and @env{QILDFLAGS} have no effect by default. The environment variables such as @env{CFLAGS}, @env{CXXFLAGS}, and @env{LDFLAGS} are unset at compile time: @noindent -Recommended practices is to set variables in front of @samp{configure} -or in front of @emph{make(1)} instead of exporting to the environment. -As follows: +Recommended practice is to set variables in the command line of +@samp{configure} or @emph{make(1)} instead of exporting to the +environment. As follows: @quotation Variables not defined in a site shell script can be set in the environment @@ -887,7 +889,7 @@ The "meta file" is a regular file created during the build mode, it contains information about the package such as program name, program version, release, fetch address, description, and other minor data extracted from processed recipes. The name of the file is generated as -@samp{$@{full_pkgname@}.tlz.txt}, it has the purpose to reflect essential +@samp{$@{full_pkgname@}.tlz.txt}, and its purpose is to reflect essential information to the user without having to look inside the package content. The content of a meta file looks like: @@ -935,7 +937,7 @@ line of @samp{description}, mentioned as the "brief description". @chapter Order files @cindex handling build order -The order mode has the purpose to resolve the build order through +The order mode has the purpose of resolving the build order through .order files. An order file contains a list of recipe names, by default does not perform any action other than to print a resolved list in descending order. For example, if @strong{a} depends on @strong{b} and @@ -960,12 +962,12 @@ c a @end example -Declaration of blank lines, colons, parentheses, and end of line are -simply ignored. Comments are allowed for lines that begin with @samp{#}. +Blank lines, colons and parentheses are simply ignored. Comment lines +beginning with @samp{#} are allowed. @noindent -An order file could be used to build a serie of packages, for example, if -the content is: +An order file could be used to build a series of packages, for example, +if the content is: @example # Image handling libraries @@ -997,17 +999,17 @@ libs/tiff @cindex package creation The "creation mode" is an internal function of qi to make new Qi compatible -packages, the creation mode is available through the -c option. A package -is produced using the contents of the Current Directory, finally the -package is written out to the file name. +compatible packages, the creation mode is selected by the -c option. +A package is produced using the contents of the Current Directory, and +the package file is written out. @example Usage: qi -c [@var{OUTPUT/packagename.tlz}]... @end example The argument for the file name to be written must contain a fully -qualified named directory as the output directory where the produced -package will be written. The file name should be composed using the +qualified named directory as the output directory where the package +produced will be written. The file name should be composed using the full name: name-version-architecture+release.tlz @sc{Example} @@ -1022,7 +1024,7 @@ In this case, the package "claws-mail-3.17.1-x86_64+1.tlz" will be written into @samp{/var/cache/qi/packages/x86_64/local/}. @noindent -All produced packages are complemented by a checksum file (.sha256). +All packages produced are complemented by a checksum file (.sha256). @node Examining packages @@ -1030,9 +1032,9 @@ All produced packages are complemented by a checksum file (.sha256). @cindex package examination The "extraction mode" serves to examine binary packages for debugging -purposes, the extraction mode is available through the -x option. It -consists of decompressing a package into a single directory, verifying -its integrity and preserving its properties. +purposes. The extraction mode is selected by the -x option. It +decompresses a package into a single directory, verifying its integrity +and preserving its properties. @example Usage: qi -x [@var{packagename.tlz}]... @@ -1046,9 +1048,10 @@ qi -x mksh-R56c-x86_64+1.tlz This action will put the content of "mksh-R56c-x86_64+1.tlz" into a single directory, this will be a private directory for the user who -requested the action, creation mode will be equal to -@strong{u=,g=rwx,o=rwx (0700)}. The package content will reside on -this location, default mask to deploy the content will be equal to + +requested the action, creation mode will be equal to @strong{u=rwx,g=,o= +(0700)}. The package content will reside on this location, default +mask to deploy the content will be equal to @strong{u=rwx,g=rwx,o=rwx (0000)}. @noindent @@ -1060,7 +1063,7 @@ The creation of the custom directory is influenced by the value of the @chapter Exit status @cindex exit codes -All the conditions of exit codes are described in this chapter. +All the exit codes are described in this chapter. @table @samp @item 0 @@ -1091,7 +1094,7 @@ Compressed files means: Supported extensions: .tar, .tar.gz, .tgz, .tar.Z, .tar.bz2, .tbz2, .tbz, .tar.xz, .txz -@item Tarballs files from tarlz(1). +@item Tarball files from tarlz(1). Supported extensions: .tar.lz, .tlz @item Zip files from unzip(1). @@ -1140,7 +1143,7 @@ variables coming from a recipe or assigned arrays that are tested. @item 6 Package already installed: -The package directory for an incoming .tlz package that already exists. +The package directory for an incoming .tlz package already exists. @item 10 Network manager error: diff --git a/qi/src/qi.in b/qi/src/qi.in index 876cdc5e..6069513e 100644 --- a/qi/src/qi.in +++ b/qi/src/qi.in @@ -52,8 +52,8 @@ usage() " Only valid for -b, -u options" \ " -t Target directory for symbolic links." \ " Only valid for -i, -d, or -u options" \ - " -k Keep \`\${srcdir}' or \`\${destdir}' on build mode," \ - " keep package directory on delete mode." \ + " -k Keep \`\${srcdir}' or \`\${destdir}' in build mode," \ + " keep package directory in delete mode." \ " Only valid for -b, -d or -u options" \ " -p Prune conflicts on package installations" \ " -r Use the fully qualified named directory as the" \ @@ -64,7 +64,7 @@ usage() " -v Be verbose (a 2nd -v gives more)" \ "" \ "Options for 'build' mode (-b):" \ - " -O Where the produced packages are written" \ + " -O Where the packages produced are written" \ " -W Where archives, patches, and recipes are expected" \ " -Z Where (compressed) sources will be found" \ " -a Architecture to use [detected]" \ @@ -874,10 +874,11 @@ resolve_mode() { return 4 fi - # Get a clean list of the file while prints its content in reverse order, - # lines containing: colons, comments, parentheses, end of line, and blank - # lines, are removed. The parentheses are used to insert a reference. - # The last `awk' in the pipe: removes nonconsecutive lines, duplicate. + # Get a clean list of the file while printing its contents in reverse + # order. The last `awk 'in the pipeline eliminates the non-consecutive + # lines, the duplicates. Blank lines, colons and parentheses are + # simply ignored, comment lines beginning with '#' are allowed + awk \ '{ gsub( /:|^#(.*)$|\([^)]*)|^$/,"" ); for( i=NF; i > 0; i-- ) print $i }' \ "$1" | awk '!s[$0]++' diff --git a/recipes/tools/graft/recipe b/recipes/tools/graft/recipe index 3112862c..14661160 100644 --- a/recipes/tools/graft/recipe +++ b/recipes/tools/graft/recipe @@ -1,6 +1,6 @@ # Build recipe for graft. # -# Copyright (c) 2017-2018 Matias Fonzo, . +# Copyright (c) 2017-2019 Matias Fonzo, . # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,7 +17,7 @@ program=graft version=2.16 arch=noarch -release=2 +release=3 # Set 'outdir' for a nice and well-organized output directory outdir="${outdir}/${arch}/tools" @@ -34,12 +34,12 @@ Graft provides a mechanism for managing multiple packages under a single directory hierarchy. Packages are installed in self contained directory trees and symbolic links from a common area are made to the package files. -This approach allows multiple versions of the same package to co-exist on -the one system. One version is the commonly available version and symbolic -links will be made to this version. New versions can be tested and once -acceptable can replace the current commonly available version. Older -versions can still be used for legacy systems by using the 'real' path -name to the package instead of the 'common' path name. +This approach allows multiple versions of the same package to coexist on +the same system. One version is the commonly available version and +symbolic links will be made to this version. New versions can be tested +and once acceptable can replace the current commonly available version. +Older versions can still be used for legacy systems by using the 'real' +path name to the package instead of the 'common' path name. " homepage=http://peters.gormand.com.au/Home/tools/graft diff --git a/recipes/tools/qi/recipe b/recipes/tools/qi/recipe index 6676dc60..5afcf9a4 100644 --- a/recipes/tools/qi/recipe +++ b/recipes/tools/qi/recipe @@ -17,7 +17,7 @@ program=qi version=1.0-rc59 arch=noarch -release=1 +release=2 # Set 'outdir' for a nice and well-organized output directory outdir="${outdir}/${arch}/tools" @@ -33,13 +33,24 @@ fetch=" description=" A user-friendly package manager. -Qi is a simple but well-integrated package manager. It can creates, +Qi is a simple but well-integrated package manager. It can create, install, remove, and upgrade software packages. Qi produces binary -packages using recipe names, these are files containing specific -instructions to build every source. Qi can manage multiple packages -under a single directory hierarchy, this method allows to maintain a set -of packages and multiple versions of them. This means that Qi could be -used as the main package manager or complement the existing one. +packages using recipes, which are files containing specific instructions +to build each package from source. Qi can manage multiple packages +under a single directory hierarchy. This method allows to maintain a +set of packages and multiple versions of them. This means that Qi could +be used as the main package manager or complement the existing one. + +Qi offers a friendly command line interface, a global configuration +file, a simple recipe layout to deploy software packages; also works +with binary packages in parallel, speeding up installations and packages +in production. The format used for packages is a simplified but safe +POSIX pax archive compressed with lzip. + +Qi is a modern (POSIX-compliant) shell script released under the +terms of the GNU General Public License. There are only two major +dependencies for the magic: graft(1) and tarlz(1), the rest is expected +to be found in any Unix-like system. " homepage=http://www.dragora.org -- 2.11.4.GIT