Browse Source

Marks deprecated settings & removes from docs

main
Eric Amodio 4 years ago
parent
commit
a90c4a4e12
2 changed files with 15 additions and 16 deletions
  1. +0
    -2
      README.md
  2. +15
    -14
      package.json

+ 0
- 2
README.md View File

@ -630,7 +630,6 @@ GitLens is highly customizable and provides many configuration settings to allow
| `gitlens.codeLens.recentChange.command` | Specifies the command to be executed when a _recent change_ code lens is clicked, set to (`gitlens.showQuickCommitFileDetails`) by default. Can be set to `false` to disable click actions on the code lens.<br /><br />`gitlens.toggleFileBlame` - toggles file blame annotations<br />`gitlens.diffWithPrevious` - opens changes with the previous revision<br />`gitlens.revealCommitInView` - reveals the commit in the Side Bar<br />`gitlens.showCommitsInView` - searches for the commit<br />`gitlens.showQuickCommitDetails` - shows details of the commit<br />`gitlens.showQuickCommitFileDetails` - show file details of the commit<br />`gitlens.showQuickFileHistory` - shows the current file history<br />`gitlens.showQuickRepoHistory` - shows the current branch history |
| `gitlens.codeLens.recentChange.enabled` | Specifies whether to provide a _recent change_ code lens, showing the author and date of the most recent commit for the file or code block |
| `gitlens.codeLens.scopes` | Specifies where Git code lens will be shown in the document<br /><br />`document` - adds code lens at the top of the document<br />`containers` - adds code lens at the start of container-like symbols (modules, classes, interfaces, etc)<br />`blocks` - adds code lens at the start of block-like symbols (functions, methods, etc) lines |
| `gitlens.codeLens.scopesByLanguage` | Deprecated. Use per-language `gitlens.codeLens.scopes` and `gitlens.codeLens.symbolScopes` settings instead |
| `gitlens.codeLens.symbolScopes` | Specifies a set of document symbols where Git code lens will or will not be shown in the document. Prefix with `!` to avoid providing a Git code lens for the symbol. Must be a member of [`SymbolKind`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#_a-namesymbolkindaspan-classcodeitem-id660symbolkindspan) |
## Status Bar Settings [#](#status-bar-settings- 'Status Bar Settings')
@ -918,7 +917,6 @@ See also [View Settings](#view-settings- 'Jump to the View settings')
| `gitlens.advanced.quickPick.closeOnFocusOut` | Specifies whether to dismiss quick pick menus when focus is lost (if not, press `ESC` to dismiss) |
| `gitlens.advanced.repositorySearchDepth` | Specifies how many folders deep to search for repositories |
| `gitlens.advanced.similarityThreshold` | Specifies the amount (percent) of similarity a deleted and added file pair must have to be considered a rename |
| `gitlens.advanced.useSymmetricDifferenceNotation` | Specifies whether to use the symmetric difference (three-dot) notation or the range (two-dot) notation for comparisons. See the [Git docs](https://git-scm.com/docs/gitrevisions#_dotted_range_notations) |
| `gitlens.strings.codeLens.unsavedChanges.recentChangeAndAuthors` | Specifies the string to be shown in place of both the _recent change_ and _authors_ code lens when there are unsaved changes |
| `gitlens.strings.codeLens.unsavedChanges.recentChangeOnly` | Specifies the string to be shown in place of the _recent change_ code lens when there are unsaved changes |
| `gitlens.strings.codeLens.unsavedChanges.authorsOnly` | Specifies the string to be shown in place of the _authors_ code lens when there are unsaved changes |

+ 15
- 14
package.json View File

@ -497,7 +497,7 @@
},
"gitlens.codeLens.scopesByLanguage": {
"deprecationMessage": "Deprecated. Use per-language `gitlens.codeLens.scopes` and `gitlens.codeLens.symbolScopes` settings instead",
"markdownDeprecationMessage": "Deprecated: Use the per-language `#gitlens.codeLens.scopes#` and `#gitlens.codeLens.symbolScopes#` settings instead"
"markdownDeprecationMessage": "Deprecated. Use the per-language `#gitlens.codeLens.scopes#` and `#gitlens.codeLens.symbolScopes#` settings instead"
},
"gitlens.codeLens.symbolScopes": {
"type": "array",
@ -661,8 +661,8 @@
"scope": "window"
},
"gitlens.gitCommands.search.showResultsInView": {
"deprecationMessage": "Deprecated: This setting has been renamed to gitlens.gitCommands.search.showResultsInSideBar",
"markdownDeprecationMessage": "Deprecated: This setting has been renamed to `#gitlens.gitCommands.search.showResultsInSideBar#`"
"deprecationMessage": "Deprecated. This setting has been renamed to gitlens.gitCommands.search.showResultsInSideBar",
"markdownDeprecationMessage": "Deprecated. This setting has been renamed to `#gitlens.gitCommands.search.showResultsInSideBar#`"
},
"gitlens.gitCommands.search.showResultsInSideBar": {
"type": [
@ -1695,19 +1695,19 @@
},
"gitlens.views.commitFileFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.files.label` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.formats.files.label#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.formats.files.label#` instead"
},
"gitlens.views.commitFileDescriptionFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.files.description` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.formats.files.description#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.formats.files.description#` instead"
},
"gitlens.views.commitFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.commits.label` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.commits.files.label#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.commits.files.label#` instead"
},
"gitlens.views.commitDescriptionFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.commits.description` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.formats.commits.description#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.formats.commits.description#` instead"
},
"gitlens.views.commits.avatars": {
"type": "boolean",
@ -2135,19 +2135,19 @@
},
"gitlens.views.stashFileFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.files.label` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.formats.files.label#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.formats.files.label#` instead"
},
"gitlens.views.stashFileDescriptionFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.files.description` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.formats.files.description#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.formats.files.description#` instead"
},
"gitlens.views.stashFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.stashes.label` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.stashes.files.label#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.stashes.files.label#` instead"
},
"gitlens.views.stashDescriptionFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.stashes.description` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.formats.stashes.description#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.formats.stashes.description#` instead"
},
"gitlens.views.stashes.files.compact": {
"type": "boolean",
@ -2179,11 +2179,11 @@
},
"gitlens.views.statusFileFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.files.label` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.formats.files.label#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.formats.files.label#` instead"
},
"gitlens.views.statusFileDescriptionFormat": {
"deprecationMessage": "Deprecated. Use `gitlens.views.formats.files.description` instead",
"markdownDeprecationMessage": "Deprecated: Use `#gitlens.views.formats.files.description#` instead"
"markdownDeprecationMessage": "Deprecated. Use `#gitlens.views.formats.files.description#` instead"
},
"gitlens.views.tags.avatars": {
"type": "boolean",
@ -2361,7 +2361,8 @@
"gitlens.advanced.useSymmetricDifferenceNotation": {
"type": "boolean",
"default": true,
"markdownDescription": "Specifies whether to use the symmetric difference (three-dot) notation or the range (two-dot) notation for comparisons. See the [Git docs](https://git-scm.com/docs/gitrevisions#_dotted_range_notations)",
"deprecationMessage": "Deprecated. This setting is no longer used",
"markdownDescription": "Deprecated. This setting is no longer used",
"scope": "window"
}
}

Loading…
Cancel
Save