diff options
| author | Mike Frysinger <vapier@google.com> | 2018-10-10 01:05:11 -0400 |
|---|---|---|
| committer | Mike Frysinger <vapier@google.com> | 2018-10-10 01:28:43 -0400 |
| commit | b8f7bb04d003f8dbcf3ef2b201fc2678308995af (patch) | |
| tree | db5a3854124122b007821a0eec28d02b09ccb999 /subcmds | |
| parent | 3891b7519d35b6bac3e81744c846ca2ed0bd1be2 (diff) | |
| download | git-repo-b8f7bb04d003f8dbcf3ef2b201fc2678308995af.tar.gz | |
update markdown/help header format
Since gitiles recommends using # headers over ---/=== underlines,
change the manifest-format.md over and all our help texts.
Change-Id: I96391d41fba769e9f26870d497cf7cf01c8d8ab3
Diffstat (limited to 'subcmds')
| -rw-r--r-- | subcmds/branches.py | 3 | ||||
| -rw-r--r-- | subcmds/forall.py | 6 | ||||
| -rw-r--r-- | subcmds/grep.py | 6 | ||||
| -rw-r--r-- | subcmds/help.py | 17 | ||||
| -rw-r--r-- | subcmds/init.py | 3 | ||||
| -rw-r--r-- | subcmds/status.py | 3 | ||||
| -rw-r--r-- | subcmds/sync.py | 6 | ||||
| -rw-r--r-- | subcmds/upload.py | 6 |
8 files changed, 13 insertions, 37 deletions
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 | ||
| 68 | Summarizes the currently available topic branches. | 68 | Summarizes the currently available topic branches. |
| 69 | 69 | ||
| 70 | Branch Display | 70 | # Branch Display |
| 71 | -------------- | ||
| 72 | 71 | ||
| 73 | The branch display output by this command is organized into four | 72 | The branch display output by this command is organized into four |
| 74 | columns of information; for example: | 73 | columns 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. | |||
| 53 | The -r option allows running the command only on projects matching | 53 | The -r option allows running the command only on projects matching |
| 54 | regex or wildcard expression. | 54 | regex or wildcard expression. |
| 55 | 55 | ||
| 56 | Output Formatting | 56 | # Output Formatting |
| 57 | ----------------- | ||
| 58 | 57 | ||
| 59 | The -p option causes '%prog' to bind pipes to the command's stdin, | 58 | The -p option causes '%prog' to bind pipes to the command's stdin, |
| 60 | stdout and stderr streams, and pipe all output into a continuous | 59 | stdout and stderr streams, and pipe all output into a continuous |
| @@ -71,8 +70,7 @@ command produces output only on stderr. Normally the -p option | |||
| 71 | causes command output to be suppressed until the command produces | 70 | causes command output to be suppressed until the command produces |
| 72 | at least one byte of output on stdout. | 71 | at least one byte of output on stdout. |
| 73 | 72 | ||
| 74 | Environment | 73 | # Environment |
| 75 | ----------- | ||
| 76 | 74 | ||
| 77 | pwd is the project's working directory. If the current client is | 75 | pwd is the project's working directory. If the current client is |
| 78 | a mirror client, then pwd is the Git repository. | 76 | a 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 = """ |
| 34 | Search for the specified patterns in all project files. | 34 | Search for the specified patterns in all project files. |
| 35 | 35 | ||
| 36 | Boolean Options | 36 | # Boolean Options |
| 37 | --------------- | ||
| 38 | 37 | ||
| 39 | The following options can appear as often as necessary to express | 38 | The following options can appear as often as necessary to express |
| 40 | the pattern to locate: | 39 | the pattern to locate: |
| @@ -47,8 +46,7 @@ in order to scan multiple trees. If the same file matches in more | |||
| 47 | than one tree, only the first result is reported, prefixed by the | 46 | than one tree, only the first result is reported, prefixed by the |
| 48 | revision name it was found under. | 47 | revision name it was found under. |
| 49 | 48 | ||
| 50 | Examples | 49 | # Examples |
| 51 | ------- | ||
| 52 | 50 | ||
| 53 | Look for a line that has '#define' and either 'MAX_PATH or 'PATH_MAX': | 51 | Look 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 | |||
| 67 | may be necessary if there are problems with the local Python | 67 | may be necessary if there are problems with the local Python |
| 68 | HTTP client or proxy configuration, but the Git binary works. | 68 | HTTP client or proxy configuration, but the Git binary works. |
| 69 | 69 | ||
| 70 | Switching Manifest Branches | 70 | # Switching Manifest Branches |
| 71 | --------------------------- | ||
| 72 | 71 | ||
| 73 | To switch to another manifest branch, `repo init -b otherbranch` | 72 | To switch to another manifest branch, `repo init -b otherbranch` |
| 74 | may be used in an existing client. However, as this only updates the | 73 | may 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 | |||
| 49 | dir/subdir/proj2 are repo projects, dir/subdir/proj3 will be shown | 49 | dir/subdir/proj2 are repo projects, dir/subdir/proj3 will be shown |
| 50 | if it is not known to repo. | 50 | if it is not known to repo. |
| 51 | 51 | ||
| 52 | Status Display | 52 | # Status Display |
| 53 | -------------- | ||
| 54 | 53 | ||
| 55 | The status display is organized into three columns of information, | 54 | The status display is organized into three columns of information, |
| 56 | for example if the file 'subcmds/status.py' is modified in the | 55 | for 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. | |||
| 155 | The --prune option can be used to remove any refs that no longer | 155 | The --prune option can be used to remove any refs that no longer |
| 156 | exist on the remote. | 156 | exist on the remote. |
| 157 | 157 | ||
| 158 | SSH Connections | 158 | # SSH Connections |
| 159 | --------------- | ||
| 160 | 159 | ||
| 161 | If at least one project remote URL uses an SSH connection (ssh://, | 160 | If at least one project remote URL uses an SSH connection (ssh://, |
| 162 | git+ssh://, or user@host:path syntax) repo will automatically | 161 | git+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 | ||
| 173 | Compatibility | 172 | # Compatibility |
| 174 | ~~~~~~~~~~~~~ | ||
| 175 | 173 | ||
| 176 | This feature is automatically disabled on Windows, due to the lack | 174 | This feature is automatically disabled on Windows, due to the lack |
| 177 | of UNIX domain socket support. | 175 | of 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 | |||
| 78 | new users. Users passed as --reviewers must already be registered | 78 | new users. Users passed as --reviewers must already be registered |
| 79 | with the code review system, or the upload will fail. | 79 | with the code review system, or the upload will fail. |
| 80 | 80 | ||
| 81 | Configuration | 81 | # Configuration |
| 82 | ------------- | ||
| 83 | 82 | ||
| 84 | review.URL.autoupload: | 83 | review.URL.autoupload: |
| 85 | 84 | ||
| @@ -126,8 +125,7 @@ is set to "true" then repo will assume you always want the equivalent | |||
| 126 | of the -t option to the repo command. If unset or set to "false" then | 125 | of the -t option to the repo command. If unset or set to "false" then |
| 127 | repo will make use of only the command line option. | 126 | repo will make use of only the command line option. |
| 128 | 127 | ||
| 129 | References | 128 | # References |
| 130 | ---------- | ||
| 131 | 129 | ||
| 132 | Gerrit Code Review: http://code.google.com/p/gerrit/ | 130 | Gerrit Code Review: http://code.google.com/p/gerrit/ |
| 133 | 131 | ||
