Skip to content

Commit 0b137f8

Browse files
committed
Use embedded code markup correctly
1 parent 9c64209 commit 0b137f8

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -228,14 +228,14 @@ Pipeline is the robust and feature-rich way to checkout from multiple repositori
228228
<dt>user.name</dt>
229229
<dd>
230230
Defines the user name value which git will assign to new commits made in the workspace.
231-
If given, `git config user.name [this]` is called before builds.
231+
If given, <code>git config user.name [this]</code> is called before builds.
232232
This overrides values from the global settings.
233233
</dd>
234234

235235
<dt>user.email</dt>
236236
<dd>
237237
Defines the user email value which git will assign to new commits made in the workspace.
238-
If given, `git config user.email [this]` is called before builds.
238+
If given, <code>git config user.email [this]</code> is called before builds.
239239
This overrides whatever is in the global settings.
240240
</dd>
241241

@@ -268,13 +268,13 @@ It then may push the merge back to the remote repository if the Git Push post-bu
268268

269269
<dt>Name of repository</dt>
270270
<dd>
271-
Name of the repository, such as `origin`, that contains the branch.
271+
Name of the repository, such as <code>origin</code>, that contains the branch.
272272
If left blank, it'll default to the name of the first repository configured.
273273
</dd>
274274

275275
<dt>Branch to merge to</dt>
276276
<dd>
277-
The name of the branch within the named repository to merge to, such as `master`.
277+
The name of the branch within the named repository to merge to, such as <code>master</code>.
278278
</dd>
279279

280280
<dt>Merge strategy</dt>
@@ -294,9 +294,9 @@ It then may push the merge back to the remote repository if the Git Push post-bu
294294
<dt>Fast-forward mode</dt>
295295
<dd>
296296
<ul>
297-
<li>`--ff`: fast-forward which gracefully falls back to a merge commit when required</li>
298-
<li>`--ff-only`: fast-forward without any fallback</li>
299-
<li>`--no-ff`: merge commit always, even if a ast-forwardwould have been allowed</li>
297+
<li><code>--ff</code>: fast-forward which gracefully falls back to a merge commit when required</li>
298+
<li><code>--ff-only</code>: fast-forward without any fallback</li>
299+
<li><code>--no-ff</code>: merge commit always, even if a ast-forwardwould have been allowed</li>
300300
</ul>
301301
</dd>
302302

@@ -315,7 +315,7 @@ It then may push the merge back to the remote repository if the Git Push post-bu
315315
<dd>
316316
If set and Jenkins is configured to poll for changes, Jenkins will ignore any revisions committed by users in this list when determining if a build should be triggered.
317317
This can be used to exclude commits done by the build itself from triggering another build, assuming the build server commits the change with a distinct SCM user.
318-
Using this behaviour will preclude the faster git `ls-remote` polling mechanism, forcing polling to require a workspace, as if you had selected the Force polling using workspace extension as well.
318+
Using this behaviour will preclude the faster <code>git ls-remote</code> polling mechanism, forcing polling to require a workspace, as if you had selected the Force polling using workspace extension as well.
319319

320320
<p>Each exclusion uses literal pattern matching, and must be separated by a new line.</p>
321321
</dd>
@@ -328,7 +328,7 @@ If set and Jenkins is configured to poll for changes, Jenkins will pay attention
328328

329329
Using this behaviour will preclude the faster remote polling mechanism, forcing polling to require a workspace thus sometimes triggering unwanted builds, as if you had selected the Force polling using workspace extension as well.
330330
This can be used to exclude commits done by the build itself from triggering another build, assuming the build server commits the change with a distinct SCM user.
331-
Using this behaviour will preclude the faster git `ls-remote` polling mechanism, forcing polling to require a workspace, as if you had selected the Force polling using workspace extension as well.
331+
Using this behaviour will preclude the faster <code>git ls-remote</code> polling mechanism, forcing polling to require a workspace, as if you had selected the Force polling using workspace extension as well.
332332

333333
<dl>
334334

@@ -435,8 +435,8 @@ Some git plugin settings can only be controlled from command line properties set
435435

436436
<dt>Default timeout</dt>
437437
<dd>
438-
The default initial git timeout value can be overridden through the property `org.jenkinsci.plugins.gitclient.Git.timeOut` (see JENKINS-11286) ).
439-
The property should be set on both master and agent to have effect (see JENKINS-22547).
438+
The default initial git timeout value can be overridden through the property <code>org.jenkinsci.plugins.gitclient.Git.timeOut</code> (see <a href="https://issues.jenkins-ci.org/browse/JENKINS-11286">JENKINS-11286</a>) ).
439+
The property should be set on both master and agent to have effect (see <a href="https://issues.jenkins-ci.org/browse/JENKINS-22547">JENKINS-22547</a>).
440440
</dd>
441441

442442
</dl>
@@ -445,6 +445,7 @@ Some git plugin settings can only be controlled from command line properties set
445445

446446
A single reference repository may contain commits from multiple repositories.
447447
For example, if a repository named `parent` includes references to submodules `child-1` and `child-2`, a reference repository could be created to cache commits from all three repositories using the commands:
448+
448449
```
449450
$ mkdir multirepository-cache.git
450451
$ cd multirepository-cache.git

0 commit comments

Comments
 (0)