Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add makechrootpkg man page #66

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ BASHCOMPLETION_LINKS = \


MANS = \
doc/makechrootpkg.1 \
doc/lddd.1 \
doc/checkpkg.1 \
doc/offload-build.1 \
Expand Down
3 changes: 3 additions & 0 deletions doc/devtools.7.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,7 @@ linkman:offload-build[1]
linkman:sogrep[1]
Find packages using a linked to a given shared library

linkman:makechrootpkg[1]
Build a PKGBUILD in a given chroot environment

include::footer.asciidoc[]
76 changes: 76 additions & 0 deletions doc/makechrootpkg.1.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
makechrootpkg(1)
================

Name
----
makechrootpkg - Build a PKGBUILD in a given chroot environment

Synopsis
--------
makechrootpkg [OPTIONS] -r <chrootdir> [--] [makepkg args]

Description
-----------

Run this script in a directory containing a PKGBUILD to build a package
inside a clean chroot. Arguments passed to this script after the
end-of-options marker (--) will be passed to makepkg.

The chroot dir consists of the following directories:
<chrootdir>/{root, copy} but only "root" is required
by default. The working copy will be created as needed

The chroot "root" directory must be created via the following
command:
mkarchroot <chrootdir>/root base-devel

This script reads {SRC,SRCPKG,PKG,LOG}DEST, MAKEFLAGS and PACKAGER
from makepkg.conf(5), if those variables are not part of the
environment.

Default makepkg args: --syncdeps --noconfirm --log --holdver --skipinteg

Options
-------

*-h*::
Show this usage message

*-c*::
Clean the chroot before building

*-d* <dir>::
Bind directory into build chroot as read-write

*-D* <dir>::
Bind directory into build chroot as read-only

*-u*::
Update the working copy of the chroot before building
This is useful for rebuilds without dirtying the pristine
chroot

*-r* <dir>::
The chroot dir to use

*-I* <pkg>::
Install a package into the working copy of the chroot

*-l* <copy>::
The directory to use as the working copy of the chroot
Useful for maintaining multiple copies
Default: $USER

*-n*::
Run namcap on the build package

*-C*::
Run checkpkg on the build package

*-T*::
Build in a temporary directory

*-U*::
Run makepkg as a specified user

include::footer.asciidoc[]