<commit_before>Poudriere Utils
===============

This repository contains some shell scripts that simplifies the management of
Poudriere jails.  The `poudriere-utils.sh` script is a thin wrapper above the
`poudriere` scripts that takes care of sensible defaults such as:

  * Creating a default Makefile and package list for each `poudriere` jail it
    creates.

  * Using intuitive defaults for the `poudriere` commands it wraps.

Defaults
--------

Many `poudriere` requires you to specify a certain number of options, and for
very vew of them a sensible default value is inferred.  The most used options
are:

  * The jail you are working on.

  * The port ports tree the jail shall use (unless there is just one ports tree
    named `default`).

  * The name of the file containing the list of ports to build.

`poudriere-utils.sh` simplifies your workflow making the following assumptions:

  * By default, a jail is named after the FreeBSD version and the architecture:

        JAIL_NAME=${VERSION}${ARCH}

    where `${VERSION}` is the FreeBSD version stripped of any non-digit
    character.

  * By default, a jail makefile is named after the jail:

        ${POUDRIERE_ETC}/${JAIL_NAME}-make.conf

  * By default, the file containing the list of ports to build on a jail is
    named after the jail:

        ${POUDRIERE_ETC}/${JAIL_NAME}-pkglist

  * If only a jail exists, it is assumed to be the default jail.

  * If only a ports tree exists, it is assumed to be the default ports tree.

In the previous list, the variable `${POUDRIERE_ETC}` indicates the `poudriere`
configuration file location, that by default is:

    /usr/local/etc/poudriere.d

As a consequence, the effect of the command:

    $ poudriere-utils.sh create -v 10.1-RELEASE

will be:

  * Assuming the current architecture is `amd64`, creating a jail named
    `101amd64`.

  * Creating an empty `${POUDRIERE_ETC}/101amd64-pkglist` file.

  * Creating the `${POUDRIERE_ETC}/101amd64-make.conf` file and append the
    following definition to it:

        WITH_PKG=yes

Usage
-----

The `poudriere-utils.sh` scripts accepts the following command syntax:

    $ poudriere-utils.sh command [options]*

The `poudriere-utils.sh` scripts currently supports the following commands:

  * `create`: Creates a new jail.

  * `delete`: Deletes an existing jail.

  * `help`: Shows the help message.

  * `run`: Executes a _bulk_ build.

The command `options` are command-specific.  The help message of any command can
be shown using the `-h` option:

    $ poudriere-utils.sh create -h

----

Copyright (c) 2015 <NAME>

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,<commit_msg>Add Installation section to README.md.<commit_after>Poudriere Utils
===============

This repository contains some shell scripts that simplifies the management of
Poudriere jails.  The `poudriere-utils.sh` script is a thin wrapper above the
`poudriere` scripts that takes care of sensible defaults such as:

  * Creating a default Makefile and package list for each `poudriere` jail it
    creates.

  * Using intuitive defaults for the `poudriere` commands it wraps.

Defaults
--------

Many `poudriere` requires you to specify a certain number of options, and for
very vew of them a sensible default value is inferred.  The most used options
are:

  * The jail you are working on.

  * The port ports tree the jail shall use (unless there is just one ports tree
    named `default`).

  * The name of the file containing the list of ports to build.

`poudriere-utils.sh` simplifies your workflow making the following assumptions:

  * By default, a jail is named after the FreeBSD version and the architecture:

        JAIL_NAME=${VERSION}${ARCH}

    where `${VERSION}` is the FreeBSD version stripped of any non-digit
    character.

  * By default, a jail makefile is named after the jail:

        ${POUDRIERE_ETC}/${JAIL_NAME}-make.conf

  * By default, the file containing the list of ports to build on a jail is
    named after the jail:

        ${POUDRIERE_ETC}/${JAIL_NAME}-pkglist

  * If only a jail exists, it is assumed to be the default jail.

  * If only a ports tree exists, it is assumed to be the default ports tree.

In the previous list, the variable `${POUDRIERE_ETC}` indicates the `poudriere`
configuration file location, that by default is:

    /usr/local/etc/poudriere.d

As a consequence, the effect of the command:

    $ poudriere-utils.sh create -v 10.1-RELEASE

will be:

  * Assuming the current architecture is `amd64`, creating a jail named
    `101amd64`.

  * Creating an empty `${POUDRIERE_ETC}/101amd64-pkglist` file.

  * Creating the `${POUDRIERE_ETC}/101amd64-make.conf` file and append the
    following definition to it:

        WITH_PKG=yes

Installation
------------

`poudriere-utils.sh` must be compiled and installed from the [latest
release tarball][latest]:

    $ ./configure
    $ make install

[latest]: https://github.com/emcrisostomo/poudriere-utils/releases/latest

Usage
-----

The `poudriere-utils.sh` scripts accepts the following command syntax:

    $ poudriere-utils.sh command [options]*

The `poudriere-utils.sh` scripts currently supports the following commands:

  * `create`: Creates a new jail.

  * `delete`: Deletes an existing jail.

  * `help`: Shows the help message.

  * `run`: Executes a _bulk_ build.

The command `options` are command-specific.  The help message of any command can
be shown using the `-h` option:

    $ poudriere-utils.sh create -h

----

Copyright (c) 2015 <NAME>

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
{'fraction_non_alphanumeric': 0.08543244671481416, 'fraction_numerical': 0.008455169984146556, 'mean_word_length': 3.495645288994458, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6997811', 'n_tokens_mistral': 1733, 'n_tokens_neox': 1657, 'n_words': 724}