Skip to content

Commit

Permalink
docs: edit reference doc for update command
Browse files Browse the repository at this point in the history
  • Loading branch information
jbogarthyde authored and alexeagle committed May 7, 2019
1 parent 8abb65d commit c4d7760
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
4 changes: 3 additions & 1 deletion packages/angular/cli/commands/update-long.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
Perform a basic update to v7 of the core framework and CLI by running the following command.
Perform a basic update to the current stable release of the core framework and CLI by running the following command.

```
ng update @angular/cli @angular/core
```

To update to the next beta or pre-release version, use the `--next=true` option.

For detailed information and guidance on updating your application, see the interactive [Angular Update Guide](https://update.angular.io/).
18 changes: 9 additions & 9 deletions packages/schematics/update/update/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"type": "object",
"properties": {
"packages": {
"description": "The names of package(s) to update.",
"description": "The package or packages to update.",
"type": "array",
"items": {
"type": "string"
Expand All @@ -15,35 +15,35 @@
}
},
"force": {
"description": "If false, will error out if installed packages are incompatible with the update.",
"description": "When false (the default), reports an error if installed packages are incompatible with the update.",
"default": false,
"type": "boolean"
},
"all": {
"description": "Whether to update all packages in package.json.",
"description": "When true, update all packages in `package.json`.",
"default": false,
"type": "boolean"
},
"next": {
"description": "Use the largest version, including beta and RCs.",
"description": "Update to the latest version, including beta and RCs.",
"default": false,
"type": "boolean"
},
"migrateOnly": {
"description": "Only perform a migration, does not update the installed version.",
"description": "Perform a migration, but do not update the installed version.",
"default": false,
"type": "boolean"
},
"from": {
"description": "Version from which to migrate from. Only available with a single package being updated, and only on migration only.",
"description": "When using `--migrateOnly` for a single package, the version of that package from which to migrate.",
"type": "string"
},
"to": {
"description": "Version up to which to apply migrations. Only available with a single package being updated, and only on migrations only. Requires from to be specified. Default to the installed version detected.",
"description": "When using `--migrateOnly` for a single package, the version of that package to which to migrate.",
"type": "string"
},
"registry": {
"description": "The NPM registry to use.",
"description": "The npm registry to use.",
"type": "string",
"oneOf": [
{
Expand All @@ -55,7 +55,7 @@
]
},
"verbose": {
"description": "Display additional details during the update process.",
"description": "When true, display additional details during the update process.",
"type": "boolean"
},
"packageManager": {
Expand Down

0 comments on commit c4d7760

Please sign in to comment.