Skip to content

Commit 02c1558

Browse files
committed
Prefer sentence per line in README
1 parent 53f6553 commit 02c1558

File tree

1 file changed

+58
-93
lines changed

1 file changed

+58
-93
lines changed

README.adoc

Lines changed: 58 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Extensions include:
6363
- <<deprecated-extensions>>
6464

6565
[[clone-extensions]]
66-
=== Clone Extensions
66+
===Clone Extensions
6767

6868
[[advanced-clone-behaviours]]
6969
==== Advanced clone behaviours
@@ -153,38 +153,34 @@ Update tracking submodules to tip of branch::
153153

154154
Use credentials from default remote of parent repository::
155155

156-
Use credentials from the default remote of the parent project. Submodule
157-
updates do not use credentials by default. Enabling this extension will
158-
provide the parent repository credentials to each of the submodule
159-
repositories. Submodule credentials require that the submodule
160-
repository must accept the same credentials as the parent project. If
161-
the parent project is cloned with https, then the authenticated
162-
submodule references must use https as well. If the parent project is
163-
cloned with ssh, then the authenticated submodule references must use
164-
ssh as well.
156+
Use credentials from the default remote of the parent project.
157+
Submodule updates do not use credentials by default.
158+
Enabling this extension will provide the parent repository credentials to each of the submodule repositories.
159+
Submodule credentials require that the submodule repository must accept the same credentials as the parent project.
160+
If the parent project is cloned with https, then the authenticated submodule references must use https as well.
161+
If the parent project is cloned with ssh, then the authenticated submodule references must use ssh as well.
165162

166163
Shallow clone::
167164

168-
Perform shallow clone of submodules. Git will not download the complete
169-
history of the project, saving time and disk space.
165+
Perform shallow clone of submodules.
166+
Git will not download the complete history of the project, saving time and disk space.
170167

171168
Shallow clone depth::
172169

173-
Set shallow clone depth for submodules. Git will only download recent
174-
history of the project, saving time and disk space.
170+
Set shallow clone depth for submodules.
171+
Git will only download recent history of the project, saving time and disk space.
175172

176173
Path of the reference repo to use during submodule update::
177174

178-
Folder containing a repository that will be used by git as a reference
179-
during submodule clone operations. This option will be ignored if the
180-
folder is not available on the agent running the build. A reference
181-
repository may contain multiple subprojects. See the combining
182-
repositories section for more details.
175+
Folder containing a repository that will be used by git as a reference during submodule clone operations.
176+
This option will be ignored if the folder is not available on the agent running the build.
177+
A reference repository may contain multiple subprojects.
178+
See the combining repositories section for more details.
183179

184180
Timeout (in minutes) for submodule operations::
185181

186-
Specify a timeout (in minutes) for submodules operations. This option
187-
overrides the default timeout.
182+
Specify a timeout (in minutes) for submodules operations.
183+
This option overrides the default timeout.
188184

189185
Number of threads to use when updating submodules::
190186

@@ -233,22 +229,18 @@ Does not remove files in the `.git` repository of the workspace.
233229
[[clean-before-checkout]]
234230
==== Clean before checkout
235231

236-
Clean the workspace *before* every checkout by deleting all untracked
237-
files and directories, including those which are specified in
238-
.gitignore. Resets all tracked files to their versioned state. Ensures
239-
that the workspace is in the same state as if cloned and checkout were
240-
performed in a new workspace. Reduces the risk that current build will
241-
be affected by files generated by prior builds. Does not remove files
242-
outside the workspace (like temporary files or cache files). Does not
243-
remove files in the `.git` repository of the workspace.
232+
Clean the workspace *before* every checkout by deleting all untracked files and directories, including those which are specified in .gitignore.
233+
Resets all tracked files to their versioned state.
234+
Ensures that the workspace is in the same state as if cloned and checkout were performed in a new workspace.
235+
Reduces the risk that current build will be affected by files generated by prior builds.
236+
Does not remove files outside the workspace (like temporary files or cache files).
237+
Does not remove files in the `.git` repository of the workspace.
244238

245239
[[git-lfs-pull-after-checkout]]
246240
==== Git LFS pull after checkout
247241

248-
Enable https://git-lfs.github.com/[git large file support] for the
249-
workspace by pulling large files after the checkout completes. Requires
250-
that the master and each agent performing an LFS checkout have installed
251-
the `git lfs` command.
242+
Enable https://git-lfs.github.com/[git large file support] for the workspace by pulling large files after the checkout completes.
243+
Requires that the master and each agent performing an LFS checkout have installed `git lfs`.
252244

253245
[[changelog-extensions]]
254246
=== Changelog Extensions
@@ -273,9 +265,8 @@ Name of branch::
273265
[[use-commit-author-in-changelog]]
274266
==== Use commit author in changelog
275267

276-
The default behavior is to use the Git commit's "Committer" value in
277-
build changesets. If this option is selected, the git commit's "Author"
278-
value is used instead.
268+
The default behavior is to use the Git commit's "Committer" value in build changesets.
269+
If this option is selected, the git commit's "Author" value is used instead.
279270

280271
[[tagging-extensions]]
281272
=== Tagging Extensions
@@ -294,33 +285,26 @@ The git plugin can start builds based on many different conditions.
294285
[[dont-trigger-a-build-on-commit-notifications]]
295286
==== Don't trigger a build on commit notifications
296287

297-
If checked, this repository will be ignored when the notifyCommit URL is
298-
accessed regardless of if the repository matches or not.
288+
If checked, this repository will be ignored when the notifyCommit URL is accessed whether the repository matches or not.
299289

300290
[[force-polling-using-workspace]]
301291
==== Force polling using workspace
302292

303-
The git plugin polls remotely using `ls-remote` when configured with a
304-
single branch (no wildcards!). When this extension is enabled, the
305-
polling is performed from a cloned copy of the workspace instead of
306-
using `ls-remote`.
293+
The git plugin polls remotely using `ls-remote` when configured with a single branch (no wildcards!).
294+
When this extension is enabled, the polling is performed from a cloned copy of the workspace instead of using `ls-remote`.
307295

308-
If this option is selected, polling will use a workspace instead of
309-
using `ls-remote`.
296+
If this option is selected, polling will use a workspace instead of using `ls-remote`.
310297

311298
[[merge-extensions]]
312299
=== Merge Extensions
313300

314301
[[merge-before-build]]
315302
==== Merge before build
316303

317-
These options allow you to perform a merge to a particular branch before
318-
building. For example, you could specify an integration branch to be
319-
built, and to merge to master. In this scenario, on every change of
320-
integration, Jenkins will perform a merge with the master branch, and
321-
try to perform a build if the merge is successful. It then may push the
322-
merge back to the remote repository if the Git Push post-build action is
323-
selected.
304+
These options allow you to perform a merge to a particular branch before building.
305+
For example, you could specify an integration branch to be built, and to merge to master.
306+
In this scenario, on every change of integration, Jenkins will perform a merge with the master branch, and try to perform a build if the merge is successful.
307+
It then may push the merge back to the remote repository if the Git Push post-build action is selected.
324308

325309
Name of repository::
326310

@@ -386,19 +370,11 @@ Excluded Users::
386370
[[polling-ignores-commits-in-certain-paths]]
387371
==== Polling ignores commits in certain paths
388372

389-
If set and Jenkins is configured to poll for changes, Jenkins will pay
390-
attention to included and/or excluded files and/or folders when
391-
determining if a build needs to be triggered.
373+
If set and Jenkins is configured to poll for changes, Jenkins will pay attention to included and/or excluded files and/or folders when determining if a build needs to be triggered.
392374

393-
Using this behaviour will preclude the faster remote polling mechanism,
394-
forcing polling to require a workspace thus sometimes triggering
395-
unwanted builds, as if you had selected the Force polling using
396-
workspace extension as well. This can be used to exclude commits done by
397-
the build itself from triggering another build, assuming the build
398-
server commits the change with a distinct SCM user. Using this behaviour
399-
will preclude the faster git ls-remote polling mechanism, forcing
400-
polling to require a workspace, as if you had selected the Force polling
401-
using workspace extension as well.
375+
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.
376+
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.
377+
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.
402378

403379
Included Regions::
404380

@@ -422,15 +398,14 @@ Excluded Messages::
422398
[[prune-stale-remote-tracking-branches]]
423399
==== Prune stale remote tracking branches
424400

425-
Runs `link:https://git-scm.com/docs/git-remote[git remote prune]` for each remote to prune obsolete local
426-
branches.
401+
Runs `link:https://git-scm.com/docs/git-remote[git remote prune]` for each remote to prune obsolete local branches.
427402

428403
[[sparse-checkout-paths]]
429404
==== Sparse Checkout paths
430405

431-
Specify the paths that you'd like to sparse checkout. This may be used
432-
for saving space (Think about a reference repository). Be sure to use a
433-
recent version of Git, at least above 1.7.10.
406+
Specify the paths that you'd like to sparse checkout.
407+
This may be used for saving space (Think about a reference repository).
408+
Be sure to use a recent version of Git, at least above 1.7.10.
434409

435410
Multiple sparse checkout path values can be added to a single job.
436411

@@ -441,13 +416,10 @@ Path::
441416
[[strategy-for-choosing-what-to-build]]
442417
==== Strategy for choosing what to build
443418

444-
When you are interested in using a job to build multiple branches, you
445-
can choose how Jenkins chooses the branches to build and the order they
446-
should be built.
419+
When you are interested in using a job to build multiple branches, you can choose how Jenkins chooses the branches to build and the order they should be built.
447420

448-
This extension point in Jenkins is used by many other plugins to control
449-
the job as it builds specific commits. When you activate those plugins,
450-
you may see them installing a custom build strategy.
421+
This extension point in Jenkins is used by many other plugins to control the job as it builds specific commits.
422+
When you activate those plugins, you may see them installing a custom build strategy.
451423

452424
Ancestry::
453425

@@ -458,7 +430,7 @@ Maximum Age of Commit::
458430

459431
Commit in Ancestry::
460432

461-
If an ancestor commit (sha1) is provided, only branches with this commit in their history will be built.
433+
If an ancestor commit (SHA-1) is provided, only branches with this commit in their history will be built.
462434

463435
Default::
464436

@@ -476,9 +448,9 @@ Inverse::
476448
[[custom-scm-name---deprecated]]
477449
==== Custom SCM name - *Deprecated*
478450

479-
Unique name for this SCM. Was needed when using Git within the Multi SCM
480-
plugin. Pipeline is the robust and feature-rich way to checkout from
481-
multiple repositories in a single job.
451+
Unique name for this SCM.
452+
Was needed when using Git within the Multi SCM plugin.
453+
Pipeline is the robust and feature-rich way to checkout from multiple repositories in a single job.
482454

483455
[[environment-variables]]
484456
== Environment Variables
@@ -493,9 +465,9 @@ GIT_LOCAL_BRANCH:: Name of branch being built without remote name, as in `master
493465

494466
=== Commit Variables
495467

496-
GIT_COMMIT:: SHA1 of the commit used in this build
497-
GIT_PREVIOUS_COMMIT:: SHA1 of the commit used in the preceding build of this project
498-
GIT_PREVIOUS_SUCCESSFUL_COMMIT:: SHA1 of the commit used in the most recent successful build of this project
468+
GIT_COMMIT:: SHA-1 of the commit used in this build
469+
GIT_PREVIOUS_COMMIT:: SHA-1 of the commit used in the preceding build of this project
470+
GIT_PREVIOUS_SUCCESSFUL_COMMIT:: SHA-1 of the commit used in the most recent successful build of this project
499471

500472
=== System Configuration Variables
501473

@@ -509,15 +481,12 @@ GIT_COMMITTER_NAME:: Committer name that will be used for **new commits in this
509481
[[properties]]
510482
== Properties
511483

512-
Some git plugin settings can only be controlled from command line
513-
properties set at Jenkins startup.
484+
Some git plugin settings can only be controlled from command line properties set at Jenkins startup.
514485

515486
=== Default timeout
516487

517-
The default git timeout value (in minutes) can be overridden by the
518-
`org.jenkinsci.plugins.gitclient.Git.timeOut` property (see https://issues.jenkins-ci.org/browse/JENKINS-11286[JENKINS-11286])
519-
). The property should be set on the master and on all agents to have effect
520-
(see https://issues.jenkins-ci.org/browse/JENKINS-22547[JENKINS-22547]).
488+
The default git timeout value (in minutes) can be overridden by the `org.jenkinsci.plugins.gitclient.Git.timeOut` property (see https://issues.jenkins-ci.org/browse/JENKINS-11286[JENKINS-11286])).
489+
The property should be set on the master and on all agents to have effect (see https://issues.jenkins-ci.org/browse/JENKINS-22547[JENKINS-22547]).
521490

522491
[[combining-repositories]]
523492
== Combining repositories
@@ -536,12 +505,8 @@ $ git fetch --all
536505
....
537506

538507
Those commands will create a single bare repository which includes the current commits from all three repositories.
539-
If that reference repository is used in the advanced clone options
540-
link:#clone-reference-repository-path[clone reference repository], it
541-
will reduce data transfer and disc use for the parent repository.
542-
If that reference repository is used in the submodule options
543-
link:#submodule-reference-repository-path[clone reference repository],
544-
it will reduce data transfer and disc use for the submodule repositories.
508+
If that reference repository is used in the advanced clone options link:#clone-reference-repository-path[clone reference repository], it will reduce data transfer and disc use for the parent repository.
509+
If that reference repository is used in the submodule options link:#submodule-reference-repository-path[clone reference repository], it will reduce data transfer and disc use for the submodule repositories.
545510

546511
[[bug-reports]]
547512
== Bug Reports

0 commit comments

Comments
 (0)