Skip to content

Commit b5d4bdb

Browse files
karimkhaleelstefanhaller
authored andcommitted
Remove deprecated configs from auto generated config.md
1 parent d8e2819 commit b5d4bdb

File tree

2 files changed

+4
-42
lines changed

2 files changed

+4
-42
lines changed

docs/Config.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@ gui:
4040
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-author-color
4141
authorColors: {}
4242

43-
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color
44-
# Deprecated: use branchColorPatterns instead
45-
branchColors: {}
46-
4743
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-branch-color
4844
branchColorPatterns: {}
4945

@@ -200,9 +196,6 @@ gui:
200196
# If true, show jump-to-window keybindings in window titles.
201197
showPanelJumps: true
202198

203-
# Deprecated: use nerdFontsVersion instead
204-
showIcons: false
205-
206199
# Nerd fonts version to use.
207200
# One of: '2' | '3' | empty string (default)
208201
# If empty, do not show icons.
@@ -347,10 +340,6 @@ git:
347340
# Command used when displaying the current branch git log in the main window
348341
branchLogCmd: git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --
349342

350-
# Command used to display git log of all branches in the main window.
351-
# Deprecated: Use `allBranchesLogCmds` instead.
352-
allBranchesLogCmd: git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium
353-
354343
# Commands used to display git log of all branches in the main window, they will be cycled in order of appearance (array of strings)
355344
allBranchesLogCmds: []
356345

@@ -375,19 +364,6 @@ git:
375364

376365
# Config for showing the log in the commits view
377366
log:
378-
# One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'
379-
# 'topo-order' makes it easier to read the git log graph, but commits may not
380-
# appear chronologically. See https://git-scm.com/docs/
381-
#
382-
# Deprecated: Configure this with `Log menu -> Commit sort order` (<c-l> in the commits window by default).
383-
order: topo-order
384-
385-
# This determines whether the git graph is rendered in the commits panel
386-
# One of 'always' | 'never' | 'when-maximised'
387-
#
388-
# Deprecated: Configure this with `Log menu -> Show git graph` (<c-l> in the commits window by default).
389-
showGraph: always
390-
391367
# displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)
392368
showWholeGraph: false
393369

@@ -449,24 +425,6 @@ os:
449425
# Command for opening a link. Should contain "{{link}}".
450426
openLink: ""
451427

452-
# EditCommand is the command for editing a file.
453-
# Deprecated: use Edit instead. Note that semantics are different:
454-
# EditCommand is just the command itself, whereas Edit contains a
455-
# "{{filename}}" variable.
456-
editCommand: ""
457-
458-
# EditCommandTemplate is the command template for editing a file
459-
# Deprecated: use EditAtLine instead.
460-
editCommandTemplate: ""
461-
462-
# OpenCommand is the command for opening a file
463-
# Deprecated: use Open instead.
464-
openCommand: ""
465-
466-
# OpenLinkCommand is the command for opening a link
467-
# Deprecated: use OpenLink instead.
468-
openLinkCommand: ""
469-
470428
# CopyToClipboardCmd is the command for copying to clipboard.
471429
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-and-pasting-from-clipboard
472430
copyToClipboardCmd: ""

pkg/jsonschema/generate_config_docs.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,10 @@ func recurseOverSchema(rootSchema, schema *jsonschema.Schema, parent *Node) {
205205
for pair := schema.Properties.Oldest(); pair != nil; pair = pair.Next() {
206206
subSchema := getSubSchema(rootSchema, schema, pair.Key)
207207

208+
if strings.Contains(strings.ToLower(subSchema.Description), "deprecated") {
209+
continue
210+
}
211+
208212
node := Node{
209213
Name: pair.Key,
210214
Description: subSchema.Description,

0 commit comments

Comments
 (0)