Add additional information to the comments for the shar script

This commit is contained in:
Erik Johnson 2014-06-23 16:00:19 -05:00
parent fa2c1f5eef
commit aa9ae49129

View file

@ -13,6 +13,10 @@
#
# It will fetch libzmq and build it as a pyzmq extension.
#
# IMPORTANT: Unpacking the shar requires uudecode, which is distributed along
# with sharutils. Thus, you should have sharutils installed on any host which
# will need to unpack the shar archive.
#
# The script is capable of building a shar archive using several methods:
#
# 1. Using a custom pip requirements file
@ -27,8 +31,10 @@
# option can be used to specify directory from which dependencies will be
# sourced. Any missing dependencies will be retrieved with pip.
#
# It is recommended to run this script on a machine which does not have any of
# the Salt dependencies already installed.
# It is strongly recommended to run this script on a machine which does not
# have any of the Salt dependencies already installed, because if the script
# detects that ZeroMQ is already installed, then pyzmq's setup.py will not
# build a bundled ZeroMQ.
#
# Run the script with -h for usage details.
#