Skip to content

Commit 008474f

Browse files
committed
Docs: Update for flags & aliases
1 parent 2f6a1bf commit 008474f

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,7 @@ If more than one task is listed, Gulp will execute all of them
5757
concurrently, that is, as if they had all been listed as dependencies of
5858
a single task.
5959

60-
Gulp does not serialize tasks listed on the command line. From using
61-
other comparable tools users may expect to execute something like
62-
`gulp clean build`, with tasks named `clean` and `build`. This will not
63-
produce the intended result, as the two tasks will be executed
64-
concurrently.
60+
By default, Gulp does not serialize tasks listed on the command line. If you would like to execute tasks serially, you must specify the `--series` flag. e.g. `gulp clean build --series`
6561

6662
Just running `gulp` will execute the task `default`. If there is no
6763
`default` task, gulp will error.
@@ -225,11 +221,8 @@ __Some flags only work with gulp 4 and will be ignored when invoked against gulp
225221

226222
MIT
227223

228-
[gittip-url]: https://www.gittip.com/WeAreFractal/
229-
[gittip-image]: http://img.shields.io/gittip/WeAreFractal.svg
230-
231224
[downloads-image]: http://img.shields.io/npm/dm/gulp-cli.svg
232-
[npm-url]: https://npmjs.org/package/gulp-cli
225+
[npm-url]: https://www.npmjs.com/package/gulp-cli
233226
[npm-image]: http://img.shields.io/npm/v/gulp-cli.svg
234227

235228
[travis-url]: https://travis-ci.org/gulpjs/gulp-cli
@@ -242,4 +235,4 @@ MIT
242235
[coveralls-image]: http://img.shields.io/coveralls/gulpjs/gulp-cli/master.svg
243236

244237
[gitter-url]: https://gitter.im/gulpjs/gulp
245-
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png
238+
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg

docs/CLI.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,7 @@ If more than one task is listed, Gulp will execute all of them
99
concurrently, that is, as if they had all been listed as dependencies of
1010
a single task.
1111

12-
Gulp does not serialize tasks listed on the command line. From using
13-
other comparable tools users may expect to execute something like
14-
`gulp clean build`, with tasks named `clean` and `build`. This will not
15-
produce the intended result, as the two tasks will be executed
16-
concurrently.
12+
By default, Gulp does not serialize tasks listed on the command line. If you would like to execute tasks serially, you must specify the `--series` flag. e.g. `gulp clean build --series`
1713

1814
Just running `gulp` will execute the task `default`. If there is no
1915
`default` task, gulp will error.
@@ -41,7 +37,7 @@ gulp has very few flags to know about. All other flags are for tasks to use if n
4137
**--require** [path]
4238
Will require a module before running the gulpfile. This is useful for transpilers but also has other applications.
4339

44-
**--gulpfile** [path]
40+
**--gulpfile** [path], **-f** [path]
4541
Manually set path of gulpfile. Useful if you have multiple gulpfiles. This will set the CWD to the gulpfile directory as well.
4642

4743
**--cwd** [path]
@@ -80,5 +76,8 @@ gulp has very few flags to know about. All other flags are for tasks to use if n
8076
**--continue**
8177
Continue execution of tasks upon failure.
8278

79+
**--series**
80+
Run tasks given on the CLI in series (the default is parallel).
81+
8382
**--log-level**, **-L**
8483
Set the loglevel. -L for least verbose and -LLLL for most verbose. -LLL is default.

0 commit comments

Comments
 (0)