From 3fb8057ac5a849aea6ca4ccf3a9d203dd1415875 Mon Sep 17 00:00:00 2001 From: Jack O'Connor Date: Tue, 23 Dec 2014 16:11:45 -0600 Subject: [PATCH] deprecate `build` in the README Reviewers: sean Reviewed By: sean Differential Revision: https://phabricator.buildinspace.com/D156 --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0489d76..fa953f5 100644 --- a/README.md +++ b/README.md @@ -226,12 +226,13 @@ Some fields (like `url` and `rev`) are specific to certain module types. There are also fields you can use in any module, which modify the the tree of files after it's fetched. These made an appearance in the fancy example above: -- `build`: A shell command to run on the fetched files. Fetching happens +- `build`: A shell command to run on the fetched files. Fetching happens somewhere in outer space (a temporary directory), and this command will be - run there. + run there. [Deprecated for security and portability reasons. This will go + away soon. The untarring/unzipping use case will be handled with the new + `unpack` field in the curl type.] - `export`: A subdirectory that peru should treat as the root of the module - tree. Everything else is dropped, including parent directories. Applies - after `build`. + tree. Everything else is dropped, including parent directories. - `files`: A file or directory, or a list of files and directories, to include in the module. Everything else is dropped, though the root of the module tree is not changed. These can have `*` or `**` globs, powered by