]>
git.proxmox.com Git - ceph.git/blob - ceph/bin/git-archive-all.sh
3 # File: git-archive-all.sh
5 # Description: A utility script that builds an archive file(s) of all
6 # git repositories and submodules in the current path.
7 # Useful for creating a single tarfile of a git super-
8 # project that contains other submodules.
10 # Examples: Use git-archive-all.sh to create archive distributions
11 # from git repositories. To use, simply do:
13 # cd $GIT_DIR; git-archive-all.sh
15 # where $GIT_DIR is the root of your git superproject.
19 ###############################################################################
21 # This program is free software; you can redistribute it and/or modify
22 # it under the terms of the GNU General Public License as published by
23 # the Free Software Foundation; either version 2 of the License, or
24 # (at your option) any later version.
26 # This program is distributed in the hope that it will be useful,
27 # but WITHOUT ANY WARRANTY; without even the implied warranty of
28 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 # GNU General Public License for more details.
31 # You should have received a copy of the GNU General Public License
32 # along with this program; if not, write to the Free Software
33 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
35 ###############################################################################
42 trap 'cleanup' QUIT EXIT
44 # For security reasons, explicitly set the internal field separator
45 # to newline, space, tab
56 echo "Usage is as follows:"
58 echo "$PROGRAM <--version>"
59 echo " Prints the program version number on a line by itself and exits."
61 echo "$PROGRAM <--usage|--help|-?>"
62 echo " Prints this usage output and exits."
64 echo "$PROGRAM [--format <fmt>] [--prefix <path>] [--verbose|-v] [--separate|-s]"
65 echo " [--tree-ish|-t <tree-ish>] [--ignore pattern] [output_file]"
66 echo " Creates an archive for the entire git superproject, and its submodules"
67 echo " using the passed parameters, described below."
69 echo " If '--format' is specified, the archive is created with the named"
70 echo " git archiver backend. Obviously, this must be a backend that git archive"
71 echo " understands. The format defaults to 'tar' if not specified."
73 echo " If '--prefix' is specified, the archive's superproject and all submodules"
74 echo " are created with the <path> prefix named. The default is to not use one."
76 echo " If '--separate' or '-s' is specified, individual archives will be created"
77 echo " for each of the superproject itself and its submodules. The default is to"
78 echo " concatenate individual archives into one larger archive."
80 echo " If '--tree-ish' is specified, the archive will be created based on whatever"
81 echo " you define the tree-ish to be. Branch names, commit hash, etc. are acceptable."
82 echo " Defaults to HEAD if not specified. See git archive's documentation for more"
83 echo " information on what a tree-ish is."
85 echo " If '--ignore' is specified, we will filter out any submodules that"
86 echo " match the specified pattern."
88 echo " If 'output_file' is specified, the resulting archive is created as the"
89 echo " file named. This parameter is essentially a path that must be writeable."
90 echo " When combined with '--separate' ('-s') this path must refer to a directory."
91 echo " Without this parameter or when combined with '--separate' the resulting"
92 echo " archive(s) are named with a dot-separated path of the archived directory and"
93 echo " a file extension equal to their format (e.g., 'superdir.submodule1dir.tar')."
95 echo " If '--verbose' or '-v' is specified, progress will be printed."
99 echo "$PROGRAM version $VERSION"
102 # Internal variables and initializations.
103 readonly PROGRAM
=`basename "$0"`
107 TMPDIR
=`mktemp -d "${TMPDIR:-/tmp}/$PROGRAM.XXXXXX"`
108 TMPFILE
=`mktemp "$TMPDIR/$PROGRAM.XXXXXX"` # Create a place to store our work's progress
109 TOARCHIVE
=`mktemp "$TMPDIR/$PROGRAM.toarchive.XXXXXX"`
110 OUT_FILE
=$OLD_PWD # assume "this directory" without a name change by default
115 [[ $
(uname
) == "Darwin" ]] && TARCMD
=gnutar
121 # RETURN VALUES/EXIT STATUS CODES
122 readonly E_BAD_OPTION
=254
123 readonly E_UNKNOWN
=255
125 # Process command-line arguments.
126 while test $# -gt 0; do
167 -? |
--usage |
--help )
173 echo "Unrecognized option: $1" >&2
184 if [ ! -z "$1" ]; then
189 # Validate parameters; error early, error often.
190 if [ $SEPARATE -eq 1 -a ! -d $OUT_FILE ]; then
191 echo "When creating multiple archives, your destination must be a directory."
192 echo "If it's not, you risk being surprised when your files are overwritten."
194 elif [ `git config -l | grep -q '^core\.bare=false'; echo $?` -ne 0 ]; then
195 echo "$PROGRAM must be run from a git working copy (i.e., not a bare repository)."
199 # Create the superproject's git-archive
200 if [ $VERBOSE -eq 1 ]; then
201 echo -n "creating superproject archive..."
203 git archive
--format=$FORMAT --prefix="$PREFIX" $TREEISH > $TMPDIR/$
(basename "$(pwd)").
$FORMAT
204 if [ $VERBOSE -eq 1 ]; then
207 echo $TMPDIR/$
(basename "$(pwd)").
$FORMAT >|
$TMPFILE # clobber on purpose
208 superfile
=`head -n 1 $TMPFILE`
210 if [ $VERBOSE -eq 1 ]; then
211 echo -n "looking for subprojects..."
213 # find all '.git' dirs, these show us the remaining to-be-archived dirs
214 # we only want directories that are below the current directory
215 find .
-mindepth 2 -name '.git' -type d
-print |
sed -e 's/^\.\///' -e 's/\.git$//' >> $TOARCHIVE
216 # as of version 1.7.8, git places the submodule .git directories under the superprojects .git dir
217 # the submodules get a .git file that points to their .git dir. we need to find all of these too
218 find .
-mindepth 2 -name '.git' -type f
-print |
xargs grep -l "gitdir" |
sed -e 's/^\.\///' -e 's/\.git$//' >> $TOARCHIVE
220 if [ -n "$IGNORE" ]; then
221 cat $TOARCHIVE |
grep -v $IGNORE > $TOARCHIVE.new
222 mv $TOARCHIVE.new
$TOARCHIVE
225 if [ $VERBOSE -eq 1 ]; then
228 cat $TOARCHIVE |
while read arch
234 if [ $VERBOSE -eq 1 ]; then
235 echo -n "archiving submodules..."
238 TREEISH
=$
(git submodule |
grep "^ .*${path%/} " | cut
-d ' ' -f 2) # git submodule does not list trailing slashes in $path
240 git archive
--format=$FORMAT --prefix="${PREFIX}$path" ${TREEISH:-HEAD} > "$TMPDIR"/"$(echo "$path" | sed -e 's/\//./g')"$FORMAT
241 if [ $FORMAT == 'zip' ]; then
242 # delete the empty directory entry; zipped submodules won't unzip if we don't do this
243 zip -d "$(tail -n 1 $TMPFILE)" "${PREFIX}${path%/}" >/dev
/null
# remove trailing '/'
245 echo "$TMPDIR"/"$(echo "$path" | sed -e 's/\//./g')"$FORMAT >> $TMPFILE
248 if [ $VERBOSE -eq 1 ]; then
252 if [ $VERBOSE -eq 1 ]; then
253 echo -n "concatenating archives into single archive..."
255 # Concatenate archives into a super-archive.
256 if [ $SEPARATE -eq 0 ]; then
257 if [ $FORMAT == 'tar' ]; then
258 sed -e '1d' $TMPFILE |
while read file; do
259 $TARCMD --concatenate -f "$superfile" "$file" && rm -f "$file"
261 elif [ $FORMAT == 'zip' ]; then
262 sed -e '1d' $TMPFILE |
while read file; do
263 # zip incorrectly stores the full path, so cd and then grow
265 zip -g "$superfile" `basename "$file"` && rm -f "$file"
270 echo "$superfile" >|
$TMPFILE # clobber on purpose
272 if [ $VERBOSE -eq 1 ]; then
276 if [ $VERBOSE -eq 1 ]; then
277 echo -n "moving archive to $OUT_FILE..."
280 mv "$file" "$OUT_FILE"
282 if [ $VERBOSE -eq 1 ]; then