blob: 5ceeb12f6c5f7af59e22256aad939563aeaedf03 [file] [log] [blame]
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -08001#
2# Copyright (C) 2009 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
Sarah Owenscecd1d82012-11-01 22:59:27 -070016from __future__ import print_function
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080017import os
18import sys
19
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080020from command import PagedCommand
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080021
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080022class Manifest(PagedCommand):
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080023 common = False
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080024 helpSummary = "Manifest inspection utility"
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080025 helpUsage = """
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080026%prog [-o {-|NAME.xml} [-r]]
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080027"""
28 _helpDescription = """
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080029
30With the -o option, exports the current manifest for inspection.
31The manifest and (if present) local_manifest.xml are combined
32together to produce a single manifest file. This file can be stored
33in a Git repository for use during future 'repo init' invocations.
34
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080035"""
36
37 @property
38 def helpDescription(self):
David Pursehouse8a68ff92012-09-24 12:15:13 +090039 helptext = self._helpDescription + '\n'
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080040 r = os.path.dirname(__file__)
41 r = os.path.dirname(r)
42 fd = open(os.path.join(r, 'docs', 'manifest-format.txt'))
43 for line in fd:
David Pursehouse8a68ff92012-09-24 12:15:13 +090044 helptext += line
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080045 fd.close()
David Pursehouse8a68ff92012-09-24 12:15:13 +090046 return helptext
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080047
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080048 def _Options(self, p):
49 p.add_option('-r', '--revision-as-HEAD',
50 dest='peg_rev', action='store_true',
51 help='Save revisions as current HEAD')
Brian Harring14a66742012-09-28 20:21:57 -070052 p.add_option('--suppress-upstream-revision', dest='peg_rev_upstream',
53 default=True, action='store_false',
54 help='If in -r mode, do not write the upstream field. '
55 'Only of use if the branch names for a sha1 manifest are '
56 'sensitive.')
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080057 p.add_option('-o', '--output-file',
58 dest='output_file',
Conley Owens918ff852012-08-07 10:44:01 -070059 default='-',
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080060 help='File to save the manifest to',
61 metavar='-|NAME.xml')
62
63 def _Output(self, opt):
64 if opt.output_file == '-':
65 fd = sys.stdout
66 else:
67 fd = open(opt.output_file, 'w')
68 self.manifest.Save(fd,
Brian Harring14a66742012-09-28 20:21:57 -070069 peg_rev = opt.peg_rev,
70 peg_rev_upstream = opt.peg_rev_upstream)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080071 fd.close()
72 if opt.output_file != '-':
Sarah Owenscecd1d82012-11-01 22:59:27 -070073 print('Saved manifest to %s' % opt.output_file, file=sys.stderr)
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080074
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080075 def Execute(self, opt, args):
Shawn O. Pearcec7a4eef2009-03-05 10:32:38 -080076 if args:
77 self.Usage()
78
79 if opt.output_file is not None:
80 self._Output(opt)
81 return
82
Sarah Owenscecd1d82012-11-01 22:59:27 -070083 print('error: no operation to perform', file=sys.stderr)
84 print('error: see repo help manifest', file=sys.stderr)
Shawn O. Pearce43c3d9e2009-03-04 14:26:50 -080085 sys.exit(1)