summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/manifest-format.md42
-rw-r--r--subcmds/branches.py3
-rw-r--r--subcmds/forall.py6
-rw-r--r--subcmds/grep.py6
-rw-r--r--subcmds/help.py17
-rw-r--r--subcmds/init.py3
-rw-r--r--subcmds/status.py3
-rw-r--r--subcmds/sync.py6
-rw-r--r--subcmds/upload.py6
9 files changed, 27 insertions, 65 deletions
diff --git a/docs/manifest-format.md b/docs/manifest-format.md
index cf48698d..c85726bc 100644
--- a/docs/manifest-format.md
+++ b/docs/manifest-format.md
@@ -1,5 +1,4 @@
1repo Manifest Format 1# repo Manifest Format
2====================
3 2
4A repo manifest describes the structure of a repo client; that is 3A repo manifest describes the structure of a repo client; that is
5the directories that are visible and where they should be obtained 4the directories that are visible and where they should be obtained
@@ -15,8 +14,7 @@ obtained by clients during `repo sync`.
15[TOC] 14[TOC]
16 15
17 16
18XML File Format 17## XML File Format
19---------------
20 18
21A manifest XML file (e.g. `default.xml`) roughly conforms to the 19A manifest XML file (e.g. `default.xml`) roughly conforms to the
22following DTD: 20following DTD:
@@ -107,14 +105,12 @@ following DTD:
107A description of the elements and their attributes follows. 105A description of the elements and their attributes follows.
108 106
109 107
110Element manifest 108### Element manifest
111----------------
112 109
113The root element of the file. 110The root element of the file.
114 111
115 112
116Element remote 113### Element remote
117--------------
118 114
119One or more remote elements may be specified. Each remote element 115One or more remote elements may be specified. Each remote element
120specifies a Git URL shared by one or more projects and (optionally) 116specifies a Git URL shared by one or more projects and (optionally)
@@ -149,8 +145,7 @@ Attribute `revision`: Name of a Git branch (e.g. `master` or
149`refs/heads/master`). Remotes with their own revision will override 145`refs/heads/master`). Remotes with their own revision will override
150the default revision. 146the default revision.
151 147
152Element default 148### Element default
153---------------
154 149
155At most one default element may be specified. Its remote and 150At most one default element may be specified. Its remote and
156revision attributes are used when a project element does not 151revision attributes are used when a project element does not
@@ -188,8 +183,7 @@ branch (specified in the `revision` attribute) rather than
188the other ref tags. 183the other ref tags.
189 184
190 185
191Element manifest-server 186### Element manifest-server
192-----------------------
193 187
194At most one manifest-server may be specified. The url attribute 188At most one manifest-server may be specified. The url attribute
195is used to specify the URL of a manifest server, which is an 189is used to specify the URL of a manifest server, which is an
@@ -217,8 +211,7 @@ the specified tag. This is used by repo sync when the --smart-tag option
217is given. 211is given.
218 212
219 213
220Element project 214### Element project
221---------------
222 215
223One or more project elements may be specified. Each element 216One or more project elements may be specified. Each element
224describes a single Git repository to be cloned into the repo 217describes a single Git repository to be cloned into the repo
@@ -295,8 +288,7 @@ rather than the `name` attribute. This attribute only applies to the
295local mirrors syncing, it will be ignored when syncing the projects in a 288local mirrors syncing, it will be ignored when syncing the projects in a
296client working directory. 289client working directory.
297 290
298Element extend-project 291### Element extend-project
299----------------------
300 292
301Modify the attributes of the named project. 293Modify the attributes of the named project.
302 294
@@ -314,8 +306,7 @@ belongs. Same syntax as the corresponding element of `project`.
314Attribute `revision`: If specified, overrides the revision of the original 306Attribute `revision`: If specified, overrides the revision of the original
315project. Same syntax as the corresponding element of `project`. 307project. Same syntax as the corresponding element of `project`.
316 308
317Element annotation 309### Element annotation
318------------------
319 310
320Zero or more annotation elements may be specified as children of a 311Zero or more annotation elements may be specified as children of a
321project element. Each element describes a name-value pair that will be 312project element. Each element describes a name-value pair that will be
@@ -325,8 +316,7 @@ prefixed with REPO__. In addition, there is an optional attribute
325"false". This attribute determines whether or not the annotation will 316"false". This attribute determines whether or not the annotation will
326be kept when exported with the manifest subcommand. 317be kept when exported with the manifest subcommand.
327 318
328Element copyfile 319### Element copyfile
329----------------
330 320
331Zero or more copyfile elements may be specified as children of a 321Zero or more copyfile elements may be specified as children of a
332project element. Each element describes a src-dest pair of files; 322project element. Each element describes a src-dest pair of files;
@@ -334,14 +324,12 @@ the "src" file will be copied to the "dest" place during `repo sync`
334command. 324command.
335"src" is project relative, "dest" is relative to the top of the tree. 325"src" is project relative, "dest" is relative to the top of the tree.
336 326
337Element linkfile 327### Element linkfile
338----------------
339 328
340It's just like copyfile and runs at the same time as copyfile but 329It's just like copyfile and runs at the same time as copyfile but
341instead of copying it creates a symlink. 330instead of copying it creates a symlink.
342 331
343Element remove-project 332### Element remove-project
344----------------------
345 333
346Deletes the named project from the internal manifest table, possibly 334Deletes the named project from the internal manifest table, possibly
347allowing a subsequent project element in the same manifest file to 335allowing a subsequent project element in the same manifest file to
@@ -351,8 +339,7 @@ This element is mostly useful in a local manifest file, where
351the user can remove a project, and possibly replace it with their 339the user can remove a project, and possibly replace it with their
352own definition. 340own definition.
353 341
354Element include 342### Element include
355---------------
356 343
357This element provides the capability of including another manifest 344This element provides the capability of including another manifest
358file into the originating manifest. Normal rules apply for the 345file into the originating manifest. Normal rules apply for the
@@ -362,8 +349,7 @@ Attribute `name`: the manifest to include, specified relative to
362the manifest repository's root. 349the manifest repository's root.
363 350
364 351
365Local Manifests 352## Local Manifests
366===============
367 353
368Additional remotes and projects may be added through local manifest 354Additional remotes and projects may be added through local manifest
369files stored in `$TOP_DIR/.repo/local_manifests/*.xml`. 355files stored in `$TOP_DIR/.repo/local_manifests/*.xml`.
diff --git a/subcmds/branches.py b/subcmds/branches.py
index 2902684a..fa1dff67 100644
--- a/subcmds/branches.py
+++ b/subcmds/branches.py
@@ -67,8 +67,7 @@ class Branches(Command):
67 67
68Summarizes the currently available topic branches. 68Summarizes the currently available topic branches.
69 69
70Branch Display 70# Branch Display
71--------------
72 71
73The branch display output by this command is organized into four 72The branch display output by this command is organized into four
74columns of information; for example: 73columns of information; for example:
diff --git a/subcmds/forall.py b/subcmds/forall.py
index 693949e2..6fb16f16 100644
--- a/subcmds/forall.py
+++ b/subcmds/forall.py
@@ -53,8 +53,7 @@ Executes the same shell command in each project.
53The -r option allows running the command only on projects matching 53The -r option allows running the command only on projects matching
54regex or wildcard expression. 54regex or wildcard expression.
55 55
56Output Formatting 56# Output Formatting
57-----------------
58 57
59The -p option causes '%prog' to bind pipes to the command's stdin, 58The -p option causes '%prog' to bind pipes to the command's stdin,
60stdout and stderr streams, and pipe all output into a continuous 59stdout and stderr streams, and pipe all output into a continuous
@@ -71,8 +70,7 @@ command produces output only on stderr. Normally the -p option
71causes command output to be suppressed until the command produces 70causes command output to be suppressed until the command produces
72at least one byte of output on stdout. 71at least one byte of output on stdout.
73 72
74Environment 73# Environment
75-----------
76 74
77pwd is the project's working directory. If the current client is 75pwd is the project's working directory. If the current client is
78a mirror client, then pwd is the Git repository. 76a mirror client, then pwd is the Git repository.
diff --git a/subcmds/grep.py b/subcmds/grep.py
index dd391cfa..1157355d 100644
--- a/subcmds/grep.py
+++ b/subcmds/grep.py
@@ -33,8 +33,7 @@ class Grep(PagedCommand):
33 helpDescription = """ 33 helpDescription = """
34Search for the specified patterns in all project files. 34Search for the specified patterns in all project files.
35 35
36Boolean Options 36# Boolean Options
37---------------
38 37
39The following options can appear as often as necessary to express 38The following options can appear as often as necessary to express
40the pattern to locate: 39the pattern to locate:
@@ -47,8 +46,7 @@ in order to scan multiple trees. If the same file matches in more
47than one tree, only the first result is reported, prefixed by the 46than one tree, only the first result is reported, prefixed by the
48revision name it was found under. 47revision name it was found under.
49 48
50Examples 49# Examples
51-------
52 50
53Look for a line that has '#define' and either 'MAX_PATH or 'PATH_MAX': 51Look for a line that has '#define' and either 'MAX_PATH or 'PATH_MAX':
54 52
diff --git a/subcmds/help.py b/subcmds/help.py
index 9bb4c8c7..67a225e5 100644
--- a/subcmds/help.py
+++ b/subcmds/help.py
@@ -107,15 +107,13 @@ Displays detailed usage information about a command.
107 107
108 self.heading('%s', heading) 108 self.heading('%s', heading)
109 self.nl() 109 self.nl()
110
111 self.heading('%s', ''.ljust(len(heading), '-'))
112 self.nl() 110 self.nl()
113 111
114 me = 'repo %s' % cmd.NAME 112 me = 'repo %s' % cmd.NAME
115 body = body.strip() 113 body = body.strip()
116 body = body.replace('%prog', me) 114 body = body.replace('%prog', me)
117 115
118 asciidoc_hdr = re.compile(r'^\n?([^\n]{1,})\n([=~-]{2,})$') 116 asciidoc_hdr = re.compile(r'^\n?#+ (.+)$')
119 for para in body.split("\n\n"): 117 for para in body.split("\n\n"):
120 if para.startswith(' '): 118 if para.startswith(' '):
121 self.write('%s', para) 119 self.write('%s', para)
@@ -125,19 +123,8 @@ Displays detailed usage information about a command.
125 123
126 m = asciidoc_hdr.match(para) 124 m = asciidoc_hdr.match(para)
127 if m: 125 if m:
128 title = m.group(1) 126 self.heading(m.group(1))
129 section_type = m.group(2)
130 if section_type[0] in ('=', '-'):
131 p = self.heading
132 else:
133 def _p(fmt, *args):
134 self.write(' ')
135 self.heading(fmt, *args)
136 p = _p
137
138 p('%s', title)
139 self.nl() 127 self.nl()
140 p('%s', ''.ljust(len(title), section_type[0]))
141 self.nl() 128 self.nl()
142 continue 129 continue
143 130
diff --git a/subcmds/init.py b/subcmds/init.py
index 47a1c9fa..4e51dfe8 100644
--- a/subcmds/init.py
+++ b/subcmds/init.py
@@ -67,8 +67,7 @@ resumeable bundle file on a content delivery network. This
67may be necessary if there are problems with the local Python 67may be necessary if there are problems with the local Python
68HTTP client or proxy configuration, but the Git binary works. 68HTTP client or proxy configuration, but the Git binary works.
69 69
70Switching Manifest Branches 70# Switching Manifest Branches
71---------------------------
72 71
73To switch to another manifest branch, `repo init -b otherbranch` 72To switch to another manifest branch, `repo init -b otherbranch`
74may be used in an existing client. However, as this only updates the 73may be used in an existing client. However, as this only updates the
diff --git a/subcmds/status.py b/subcmds/status.py
index 60e26ff4..b47c8736 100644
--- a/subcmds/status.py
+++ b/subcmds/status.py
@@ -49,8 +49,7 @@ includes deeper items. For example, if dir/subdir/proj1 and
49dir/subdir/proj2 are repo projects, dir/subdir/proj3 will be shown 49dir/subdir/proj2 are repo projects, dir/subdir/proj3 will be shown
50if it is not known to repo. 50if it is not known to repo.
51 51
52Status Display 52# Status Display
53--------------
54 53
55The status display is organized into three columns of information, 54The status display is organized into three columns of information,
56for example if the file 'subcmds/status.py' is modified in the 55for example if the file 'subcmds/status.py' is modified in the
diff --git a/subcmds/sync.py b/subcmds/sync.py
index cda47fdd..943a0264 100644
--- a/subcmds/sync.py
+++ b/subcmds/sync.py
@@ -155,8 +155,7 @@ exist locally.
155The --prune option can be used to remove any refs that no longer 155The --prune option can be used to remove any refs that no longer
156exist on the remote. 156exist on the remote.
157 157
158SSH Connections 158# SSH Connections
159---------------
160 159
161If at least one project remote URL uses an SSH connection (ssh://, 160If at least one project remote URL uses an SSH connection (ssh://,
162git+ssh://, or user@host:path syntax) repo will automatically 161git+ssh://, or user@host:path syntax) repo will automatically
@@ -170,8 +169,7 @@ environment variable to 'ssh'. For example:
170 export GIT_SSH=ssh 169 export GIT_SSH=ssh
171 %prog 170 %prog
172 171
173Compatibility 172# Compatibility
174~~~~~~~~~~~~~
175 173
176This feature is automatically disabled on Windows, due to the lack 174This feature is automatically disabled on Windows, due to the lack
177of UNIX domain socket support. 175of UNIX domain socket support.
diff --git a/subcmds/upload.py b/subcmds/upload.py
index fdc7e28d..c1f5c0ff 100644
--- a/subcmds/upload.py
+++ b/subcmds/upload.py
@@ -78,8 +78,7 @@ added to the respective list of users, and emails are sent to any
78new users. Users passed as --reviewers must already be registered 78new users. Users passed as --reviewers must already be registered
79with the code review system, or the upload will fail. 79with the code review system, or the upload will fail.
80 80
81Configuration 81# Configuration
82-------------
83 82
84review.URL.autoupload: 83review.URL.autoupload:
85 84
@@ -126,8 +125,7 @@ is set to "true" then repo will assume you always want the equivalent
126of the -t option to the repo command. If unset or set to "false" then 125of the -t option to the repo command. If unset or set to "false" then
127repo will make use of only the command line option. 126repo will make use of only the command line option.
128 127
129References 128# References
130----------
131 129
132Gerrit Code Review: http://code.google.com/p/gerrit/ 130Gerrit Code Review: http://code.google.com/p/gerrit/
133 131