Skip to content

Commit f665369

Browse files
committed
Merge branch 'ja/doc-synopsis-style-yet-more' into seen
Synopsis and options in the documentation for 'git format-patch', 'git imap-send', 'git send-email', and 'git request-pull' have been updated to the modern style. * ja/doc-synopsis-style-yet-more: doc: convert git-request-pull synopsis and options to new style doc: convert git-send-email synopsis and options to new style doc: convert git-format-patch synopsis and options to new style doc: convert git-imap-send synopsis and options to new style
2 parents a554d4b + f5db762 commit f665369

7 files changed

Lines changed: 292 additions & 281 deletions

File tree

Documentation/config/imap.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
`imap.authMethod`::
4242
Specify the authentication method for authenticating with the IMAP server.
4343
If Git was built with the NO_CURL option, or if your curl version is older
44-
than 7.34.0, or if you're running git-imap-send with the `--no-curl`
44+
than 7.34.0, or if you're running `git-imap-send` with the `--no-curl`
4545
option, the only supported methods are `PLAIN`, `CRAM-MD5`, `OAUTHBEARER`
4646
and `XOAUTH2`. If this is not set then `git imap-send` uses the basic IMAP
4747
plaintext `LOGIN` command.
Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
sendemail.identity::
1+
`sendemail.identity`::
22
A configuration identity. When given, causes values in the
33
`sendemail.<identity>` subsection to take precedence over
44
values in the `sendemail` section. The default identity is
55
the value of `sendemail.identity`.
66

7-
sendemail.smtpEncryption::
7+
`sendemail.smtpEncryption`::
88
See linkgit:git-send-email[1] for description. Note that this
99
setting is not subject to the `identity` mechanism.
1010

11-
sendemail.smtpSSLCertPath::
11+
`sendemail.smtpSSLCertPath`::
1212
Path to ca-certificates (either a directory or a single file).
1313
Set it to an empty string to disable certificate verification.
1414

15-
sendemail.smtpSSLClientCert::
15+
`sendemail.smtpSSLClientCert`::
1616
Path to the client certificate file to present if requested by the
1717
server. This is required when the server is set up to verify client
1818
certificates. If the corresponding private key is not included in the
1919
file, it must be supplied using `sendemail.smtpSSLClientKey` or the
2020
`--smtp-ssl-client-key` option.
2121

22-
sendemail.smtpSSLClientKey::
22+
`sendemail.smtpSSLClientKey`::
2323
Path to the client private key file that corresponds to the client
2424
certificate. To avoid misconfiguration, this configuration must be used
2525
in conjunction with `sendemail.smtpSSLClientCert` or the
@@ -28,45 +28,45 @@ sendemail.smtpSSLClientKey::
2828
the certificate. Visit https://metacpan.org/pod/IO::Socket::SSL for more
2929
details.
3030

31-
sendemail.<identity>.*::
32-
Identity-specific versions of the `sendemail.*` parameters
31+
`sendemail.<identity>.<config>`::
32+
Identity-specific versions of the `sendemail.<config>` parameters
3333
found below, taking precedence over those when this
3434
identity is selected, through either the command-line or
3535
`sendemail.identity`.
3636

37-
sendemail.multiEdit::
37+
`sendemail.multiEdit`::
3838
If `true` (default), a single editor instance will be spawned to edit
3939
files you have to edit (patches when `--annotate` is used, and the
4040
summary when `--compose` is used). If `false`, files will be edited one
4141
after the other, spawning a new editor each time.
4242

43-
sendemail.confirm::
43+
`sendemail.confirm`::
4444
Sets the default for whether to confirm before sending. Must be
4545
one of `always`, `never`, `cc`, `compose`, or `auto`. See `--confirm`
4646
in the linkgit:git-send-email[1] documentation for the meaning of these
4747
values.
4848

49-
sendemail.mailmap::
49+
`sendemail.mailmap`::
5050
If `true`, makes linkgit:git-send-email[1] assume `--mailmap`,
5151
otherwise assume `--no-mailmap`. `False` by default.
5252

53-
sendemail.mailmap.file::
53+
`sendemail.mailmap.file`::
5454
The location of a linkgit:git-send-email[1] specific augmenting
5555
mailmap file. The default mailmap and `mailmap.file` are loaded
5656
first. Thus, entries in this file take precedence over entries in
5757
the default mailmap locations. See linkgit:gitmailmap[5].
5858

59-
sendemail.mailmap.blob::
59+
`sendemail.mailmap.blob`::
6060
Like `sendemail.mailmap.file`, but consider the value as a reference
6161
to a blob in the repository. Entries in `sendemail.mailmap.file`
6262
take precedence over entries here. See linkgit:gitmailmap[5].
6363

64-
sendemail.aliasesFile::
64+
`sendemail.aliasesFile`::
6565
To avoid typing long email addresses, point this to one or more
6666
email aliases files. You must also supply `sendemail.aliasFileType`.
6767

68-
sendemail.aliasFileType::
69-
Format of the file(s) specified in sendemail.aliasesFile. Must be
68+
`sendemail.aliasFileType`::
69+
Format of the file(s) specified in `sendemail.aliasesFile`. Must be
7070
one of `mutt`, `mailrc`, `pine`, `elm`, `gnus`, or `sendmail`.
7171
+
7272
What an alias file in each format looks like can be found in
@@ -75,7 +75,7 @@ differences and limitations from the standard formats are
7575
described below:
7676
+
7777
--
78-
sendmail;;
78+
`sendmail`;;
7979
* Quoted aliases and quoted addresses are not supported: lines that
8080
contain a `"` symbol are ignored.
8181
* Redirection to a file (`/path/name`) or pipe (`|command`) is not
@@ -85,54 +85,54 @@ sendmail;;
8585
explicitly unsupported constructs, and any other lines that are not
8686
recognized by the parser.
8787
--
88-
sendemail.annotate::
89-
sendemail.bcc::
90-
sendemail.cc::
91-
sendemail.ccCmd::
92-
sendemail.chainReplyTo::
93-
sendemail.envelopeSender::
94-
sendemail.from::
95-
sendemail.headerCmd::
96-
sendemail.signedOffByCc::
97-
sendemail.smtpPass::
98-
sendemail.suppressCc::
99-
sendemail.suppressFrom::
100-
sendemail.to::
101-
sendemail.toCmd::
102-
sendemail.smtpDomain::
103-
sendemail.smtpServer::
104-
sendemail.smtpServerPort::
105-
sendemail.smtpServerOption::
106-
sendemail.smtpUser::
107-
sendemail.imapSentFolder::
108-
sendemail.useImapOnly::
109-
sendemail.thread::
110-
sendemail.transferEncoding::
111-
sendemail.validate::
112-
sendemail.xmailer::
88+
`sendemail.annotate`::
89+
`sendemail.bcc`::
90+
`sendemail.cc`::
91+
`sendemail.ccCmd`::
92+
`sendemail.chainReplyTo`::
93+
`sendemail.envelopeSender`::
94+
`sendemail.from`::
95+
`sendemail.headerCmd`::
96+
`sendemail.signedOffByCc`::
97+
`sendemail.smtpPass`::
98+
`sendemail.suppressCc`::
99+
`sendemail.suppressFrom`::
100+
`sendemail.to`::
101+
`sendemail.toCmd`::
102+
`sendemail.smtpDomain`::
103+
`sendemail.smtpServer`::
104+
`sendemail.smtpServerPort`::
105+
`sendemail.smtpServerOption`::
106+
`sendemail.smtpUser`::
107+
`sendemail.imapSentFolder`::
108+
`sendemail.useImapOnly`::
109+
`sendemail.thread`::
110+
`sendemail.transferEncoding`::
111+
`sendemail.validate`::
112+
`sendemail.xmailer`::
113113
These configuration variables all provide a default for
114114
linkgit:git-send-email[1] command-line options. See its
115115
documentation for details.
116116

117-
sendemail.outlookidfix::
117+
`sendemail.outlookidfix`::
118118
If `true`, makes linkgit:git-send-email[1] assume `--outlook-id-fix`,
119119
and if `false` assume `--no-outlook-id-fix`. If not specified, it will
120120
behave the same way as if `--outlook-id-fix` is not specified.
121121

122-
sendemail.signedOffCc (deprecated)::
122+
`sendemail.signedOffCc` (deprecated)::
123123
Deprecated alias for `sendemail.signedOffByCc`.
124124

125-
sendemail.smtpBatchSize::
125+
`sendemail.smtpBatchSize`::
126126
Number of messages to be sent per connection, after that a relogin
127127
will happen. If the value is `0` or undefined, send all messages in
128128
one connection.
129129
See also the `--batch-size` option of linkgit:git-send-email[1].
130130

131-
sendemail.smtpReloginDelay::
131+
`sendemail.smtpReloginDelay`::
132132
Seconds to wait before reconnecting to the smtp server.
133133
See also the `--relogin-delay` option of linkgit:git-send-email[1].
134134

135-
sendemail.forbidSendmailVariables::
135+
`sendemail.forbidSendmailVariables`::
136136
To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
137137
will abort with a warning if any configuration options for `sendmail`
138138
exist. Set this variable to bypass the check.

Documentation/diff-options.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ endif::git-diff[]
1313
endif::git-format-patch[]
1414

1515
ifdef::git-format-patch[]
16-
-p::
17-
--no-stat::
16+
`-p`::
17+
`--no-stat`::
1818
Generate plain patches without any diffstats.
1919
endif::git-format-patch[]
2020

@@ -893,8 +893,8 @@ endif::git-format-patch[]
893893
reverted with `--ita-visible-in-index`. Both options are
894894
experimental and could be removed in future.
895895

896-
--max-depth=<depth>::
897-
For each pathspec given on command line, descend at most `<depth>`
896+
`--max-depth=<depth>`::
897+
For each pathspec given on command line, descend at most _<depth>_
898898
levels of directories. A value of `-1` means no limit.
899899
Cannot be combined with wildcards in the pathspec.
900900
Given a tree containing `foo/bar/baz`, the following list shows the

0 commit comments

Comments
 (0)