Skip to content

Commit cd21d1f

Browse files
committed
Revert "Wrap comments in Config.md"
This reverts commit e1b4d86.
1 parent fb05a0b commit cd21d1f

File tree

3 files changed

+170
-309
lines changed

3 files changed

+170
-309
lines changed

docs/Config.md

Lines changed: 49 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ gui:
4949
# Map of filenames to icon properties (icon and color)
5050
filenames: {}
5151

52-
# Map of file extensions (including the dot) to icon properties
53-
# (icon and color)
52+
# Map of file extensions (including the dot) to icon properties (icon and color)
5453
extensions: {}
5554

5655
# The number of lines you scroll by when scrolling the main window
@@ -65,15 +64,12 @@ gui:
6564
# One of: 'margin' (default) | 'jump'
6665
scrollOffBehavior: margin
6766

68-
# The number of spaces per tab; used for everything that's shown in the
69-
# main view, but probably mostly relevant for diffs.
70-
# Note that when using a pager, the pager has its own tab width setting,
71-
# so you need to pass it separately in the pager command.
67+
# The number of spaces per tab; used for everything that's shown in the main view, but probably mostly relevant for diffs.
68+
# Note that when using a pager, the pager has its own tab width setting, so you need to pass it separately in the pager command.
7269
tabWidth: 4
7370

7471
# If true, capture mouse events.
75-
# When mouse events are captured, it's a little harder to select text: e.g.
76-
# requiring you to hold the option key when on macOS.
72+
# When mouse events are captured, it's a little harder to select text: e.g. requiring you to hold the option key when on macOS.
7773
mouseEvents: true
7874

7975
# If true, do not show a warning when amending a commit.
@@ -85,43 +81,33 @@ gui:
8581
# If true, do not show warning when applying/popping the stash
8682
skipStashWarning: false
8783

88-
# If true, do not show a warning when attempting to commit without any staged
89-
# files; instead stage all unstaged files.
84+
# If true, do not show a warning when attempting to commit without any staged files; instead stage all unstaged files.
9085
skipNoStagedFilesWarning: false
9186

9287
# If true, do not show a warning when rewording a commit via an external editor
9388
skipRewordInEditorWarning: false
9489

95-
# Fraction of the total screen width to use for the left side section.
96-
# You may want to pick a small number (e.g. 0.2) if you're using a narrow
97-
# screen, so that you can see more of the main section.
90+
# Fraction of the total screen width to use for the left side section. You may want to pick a small number (e.g. 0.2) if you're using a narrow screen, so that you can see more of the main section.
9891
# Number from 0 to 1.0.
9992
sidePanelWidth: 0.3333
10093

101-
# If true, increase the height of the focused side window; creating an
102-
# accordion effect.
94+
# If true, increase the height of the focused side window; creating an accordion effect.
10395
expandFocusedSidePanel: false
10496

105-
# The weight of the expanded side panel, relative to the other panels.
106-
# 2 means twice as tall as the other panels. Only relevant if
107-
# `expandFocusedSidePanel` is true.
97+
# The weight of the expanded side panel, relative to the other panels. 2 means
98+
# twice as tall as the other panels. Only relevant if `expandFocusedSidePanel` is true.
10899
expandedSidePanelWeight: 2
109100

110-
# Sometimes the main window is split in two (e.g. when the selected file
111-
# has both staged and unstaged changes). This setting controls how the
112-
# two sections are split.
101+
# Sometimes the main window is split in two (e.g. when the selected file has both staged and unstaged changes). This setting controls how the two sections are split.
113102
# Options are:
114103
# - 'horizontal': split the window horizontally
115104
# - 'vertical': split the window vertically
116-
# - 'flexible': (default) split the window horizontally if the window is
117-
# wide enough, otherwise split vertically
105+
# - 'flexible': (default) split the window horizontally if the window is wide enough, otherwise split vertically
118106
mainPanelSplitMode: flexible
119107

120-
# How the window is split when in half screen mode (i.e. after hitting
121-
# '+' once).
108+
# How the window is split when in half screen mode (i.e. after hitting '+' once).
122109
# Possible values:
123-
# - 'left': split the window horizontally (side panel on the left, main
124-
# view on the right)
110+
# - 'left': split the window horizontally (side panel on the left, main view on the right)
125111
# - 'top': split the window vertically (side panel on top, main view below)
126112
enlargedSideViewLocation: left
127113

@@ -130,11 +116,10 @@ gui:
130116
# paragraphs of markdown text.
131117
wrapLinesInStagingView: true
132118

133-
# If true, hunk selection mode will be enabled by default when entering
134-
# the staging view.
119+
# If true, hunk selection mode will be enabled by default when entering the staging view.
135120
useHunkModeInStagingView: true
136121

137-
# One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru' | 'pt'
122+
# One of 'auto' (default) | 'en' | 'zh-CN' | 'zh-TW' | 'pl' | 'nl' | 'ja' | 'ko' | 'ru'
138123
language: auto
139124

140125
# Format used when displaying time e.g. commit time.
@@ -207,15 +192,11 @@ gui:
207192
# If true, show the '5 of 20' footer at the bottom of list views
208193
showListFooter: true
209194

210-
# If true, display the files in the file views as a tree. If false,
211-
# display the files as a flat list.
212-
# This can be toggled from within Lazygit with the '`' key, but that will
213-
# not change the default.
195+
# If true, display the files in the file views as a tree. If false, display the files as a flat list.
196+
# This can be toggled from within Lazygit with the '`' key, but that will not change the default.
214197
showFileTree: true
215198

216-
# If true, add a "/" root item in the file tree representing the root of
217-
# the repository. It is only added when necessary, i.e. when there is more
218-
# than one item at top level.
199+
# If true, add a "/" root item in the file tree representing the root of the repository. It is only added when necessary, i.e. when there is more than one item at top level.
219200
showRootItemInFileTree: true
220201

221202
# If true, show the number of lines changed per file in the Files view
@@ -227,9 +208,7 @@ gui:
227208
# If true, show the command log
228209
showCommandLog: true
229210

230-
# If true, show the bottom line that contains keybinding info and useful
231-
# buttons. If false, this line will be hidden except to display a loader
232-
# for an in-progress action.
211+
# If true, show the bottom line that contains keybinding info and useful buttons. If false, this line will be hidden except to display a loader for an in-progress action.
233212
showBottomLine: true
234213

235214
# If true, show jump-to-window keybindings in window titles.
@@ -240,16 +219,13 @@ gui:
240219
# If empty, do not show icons.
241220
nerdFontsVersion: ""
242221

243-
# If true (default), file icons are shown in the file views. Only relevant
244-
# if NerdFontsVersion is not empty.
222+
# If true (default), file icons are shown in the file views. Only relevant if NerdFontsVersion is not empty.
245223
showFileIcons: true
246224

247-
# Length of author name in (non-expanded) commits view. 2 means show
248-
# initials only.
225+
# Length of author name in (non-expanded) commits view. 2 means show initials only.
249226
commitAuthorShortLength: 2
250227

251-
# Length of author name in expanded commits view. 2 means show
252-
# initials only.
228+
# Length of author name in expanded commits view. 2 means show initials only.
253229
commitAuthorLongLength: 17
254230

255231
# Length of commit hash in commits view. 0 shows '*' if NF icons aren't on.
@@ -267,21 +243,18 @@ gui:
267243

268244
# Whether to split the main window when viewing file changes.
269245
# One of: 'auto' | 'always'
270-
# If 'auto', only split the main window when a file has both staged and
271-
# unstaged changes
246+
# If 'auto', only split the main window when a file has both staged and unstaged changes
272247
splitDiff: auto
273248

274-
# Default size for focused window. Can be changed from within Lazygit
275-
# with '+' and '_' (but this won't change the default).
249+
# Default size for focused window. Can be changed from within Lazygit with '+' and '_' (but this won't change the default).
276250
# One of: 'normal' (default) | 'half' | 'full'
277251
screenMode: normal
278252

279253
# Window border style.
280254
# One of 'rounded' (default) | 'single' | 'double' | 'hidden' | 'bold'
281255
border: rounded
282256

283-
# If true, show a seriously epic explosion animation when nuking the
284-
# working tree.
257+
# If true, show a seriously epic explosion animation when nuking the working tree.
285258
animateExplosion: true
286259

287260
# Whether to stack UI components on top of each other.
@@ -314,16 +287,14 @@ gui:
314287
# If true, jump to the Files panel after applying a stash
315288
switchToFilesAfterStashApply: true
316289

317-
# If true, when using the panel jump keys (default 1 through 5) and target
318-
# panel is already active, go to next tab instead
290+
# If true, when using the panel jump keys (default 1 through 5) and target panel is already active, go to next tab instead
319291
switchTabsWithPanelJumpKeys: false
320292

321293
# Config relating to git
322294
git:
323295
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md
324296
paging:
325-
# Value of the --color arg in the git diff command. Some pagers want this
326-
# to be set to 'always' and some want it set to 'never'
297+
# Value of the --color arg in the git diff command. Some pagers want this to be set to 'always' and some want it set to 'never'
327298
colorArg: always
328299

329300
# e.g.
@@ -335,10 +306,7 @@ git:
335306
# e.g. 'difft --color=always'
336307
externalDiffCommand: ""
337308

338-
# If true, Lazygit will use git's `diff.external` config for paging. The
339-
# advantage over `externalDiffCommand` is that this can be configured per
340-
# file type in .gitattributes; see
341-
# https://git-scm.com/docs/gitattributes#_defining_an_external_diff_driver.
309+
# If true, Lazygit will use git's `diff.external` config for paging. The advantage over `externalDiffCommand` is that this can be configured per file type in .gitattributes; see https://git-scm.com/docs/gitattributes#_defining_an_external_diff_driver.
342310
useExternalDiffGitConfig: false
343311

344312
# Config relating to committing
@@ -354,26 +322,22 @@ git:
354322

355323
# Config relating to merging
356324
merging:
357-
# If true, run merges in a subprocess so that if a commit message is
358-
# required, Lazygit will not hang.
325+
# If true, run merges in a subprocess so that if a commit message is required, Lazygit will not hang
359326
# Only applicable to unix users.
360327
manualCommit: false
361328

362329
# Extra args passed to `git merge`, e.g. --no-ff
363330
args: ""
364331

365-
# The commit message to use for a squash merge commit. Can contain
366-
# "{{selectedRef}}" and "{{currentBranch}}" placeholders.
332+
# The commit message to use for a squash merge commit. Can contain "{{selectedRef}}" and "{{currentBranch}}" placeholders.
367333
squashMergeMessage: Squash merge {{selectedRef}} into {{currentBranch}}
368334

369-
# list of branches that are considered 'main' branches, used when
370-
# displaying commits
335+
# list of branches that are considered 'main' branches, used when displaying commits
371336
mainBranches:
372337
- master
373338
- main
374339

375-
# Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit
376-
# hooks will be skipped when the commit message starts with 'WIP'
340+
# Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP'
377341
skipHookPrefix: WIP
378342

379343
# If true, periodically fetch from remote
@@ -382,10 +346,7 @@ git:
382346
# If true, periodically refresh files and submodules
383347
autoRefresh: true
384348

385-
# If not "none", lazygit will automatically fast-forward local branches
386-
# to match their upstream after fetching. Applies to branches that are not
387-
# the currently checked out branch, and only to those that are strictly
388-
# behind their upstream (as opposed to diverged).
349+
# If not "none", lazygit will automatically fast-forward local branches to match their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).
389350
# Possible values: 'none' | 'onlyMainBranches' | 'allBranches'
390351
autoForwardBranches: onlyMainBranches
391352

@@ -401,22 +362,17 @@ git:
401362
# Command used when displaying the current branch git log in the main window
402363
branchLogCmd: git log --graph --color=always --abbrev-commit --decorate --date=relative --pretty=medium {{branchName}} --
403364

404-
# Commands used to display git log of all branches in the main window,
405-
# they will be cycled in order of appearance (array of strings)
365+
# Commands used to display git log of all branches in the main window, they will be cycled in order of appearance (array of strings)
406366
allBranchesLogCmds:
407367
- git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium
408368

409-
# If true, git diffs are rendered with the `--ignore-all-space` flag,
410-
# which ignores whitespace changes. Can be toggled from within Lazygit
411-
# with `<c-w>`.
369+
# If true, git diffs are rendered with the `--ignore-all-space` flag, which ignores whitespace changes. Can be toggled from within Lazygit with `<c-w>`.
412370
ignoreWhitespaceInDiffView: false
413371

414-
# The number of lines of context to show around each diff hunk. Can be
415-
# changed from within Lazygit with the `{` and `}` keys.
372+
# The number of lines of context to show around each diff hunk. Can be changed from within Lazygit with the `{` and `}` keys.
416373
diffContextSize: 3
417374

418-
# The threshold for considering a file to be renamed, in percent. Can be
419-
# changed from within Lazygit with the `(` and `)` keys.
375+
# The threshold for considering a file to be renamed, in percent. Can be changed from within Lazygit with the `(` and `)` keys.
420376
renameSimilarityThreshold: 50
421377

422378
# If true, do not spawn a separate process when using GPG
@@ -441,34 +397,29 @@ git:
441397
# Config for showing the log in the commits view
442398
log:
443399
# One of: 'date-order' | 'author-date-order' | 'topo-order' | 'default'
444-
# 'topo-order' makes it easier to read the git log graph, but commits may
445-
# not appear chronologically. See https://git-scm.com/docs/
400+
# 'topo-order' makes it easier to read the git log graph, but commits may not
401+
# appear chronologically. See https://git-scm.com/docs/
446402
#
447-
# Can be changed from within Lazygit with `Log menu -> Commit sort order`
448-
# (`<c-l>` in the commits window by default).
403+
# Can be changed from within Lazygit with `Log menu -> Commit sort order` (`<c-l>` in the commits window by default).
449404
order: topo-order
450405

451406
# This determines whether the git graph is rendered in the commits panel
452407
# One of 'always' | 'never' | 'when-maximised'
453408
#
454-
# Can be toggled from within lazygit with `Log menu -> Show git graph`
455-
# (`<c-l>` in the commits window by default).
409+
# Can be toggled from within lazygit with `Log menu -> Show git graph` (`<c-l>` in the commits window by default).
456410
showGraph: always
457411

458-
# displays the whole git graph by default in the commits view (equivalent
459-
# to passing the `--all` argument to `git log`)
412+
# displays the whole git graph by default in the commits view (equivalent to passing the `--all` argument to `git log`)
460413
showWholeGraph: false
461414

462415
# How branches are sorted in the local branches view.
463416
# One of: 'date' (default) | 'recency' | 'alphabetical'
464-
# Can be changed from within Lazygit with the Sort Order menu (`s`) in
465-
# the branches panel.
417+
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the branches panel.
466418
localBranchSortOrder: date
467419

468420
# How branches are sorted in the remote branches view.
469421
# One of: 'date' (default) | 'alphabetical'
470-
# Can be changed from within Lazygit with the Sort Order menu (`s`) in
471-
# the remote branches panel.
422+
# Can be changed from within Lazygit with the Sort Order menu (`s`) in the remote branches panel.
472423
remoteBranchSortOrder: date
473424

474425
# When copying commit hashes to the clipboard, truncate them to this
@@ -496,12 +447,10 @@ refresher:
496447
# If true, show a confirmation popup before quitting Lazygit
497448
confirmOnQuit: false
498449

499-
# If true, exit Lazygit when the user presses escape in a context where
500-
# there is nothing to cancel/close
450+
# If true, exit Lazygit when the user presses escape in a context where there is nothing to cancel/close
501451
quitOnTopLevelReturn: false
502452

503-
# Config relating to things outside of Lazygit like how files are opened,
504-
# copying to clipboard, etc
453+
# Config relating to things outside of Lazygit like how files are opened, copying to clipboard, etc
505454
os:
506455
# Command for editing a file. Should contain "{{filename}}".
507456
edit: ""
@@ -539,10 +488,7 @@ os:
539488
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-command-for-copying-to-and-pasting-from-clipboard
540489
readFromClipboardCmd: ""
541490

542-
# A shell startup file containing shell aliases or shell functions. This
543-
# will be sourced before running any shell commands, so that shell
544-
# functions are available in the `:` command prompt or even in custom
545-
# commands.
491+
# A shell startup file containing shell aliases or shell functions. This will be sourced before running any shell commands, so that shell functions are available in the `:` command prompt or even in custom commands.
546492
# See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#using-aliases-or-functions-in-shell-commands
547493
shellFunctionsFile: ""
548494

@@ -557,15 +503,13 @@ customCommands: []
557503
services: {}
558504

559505
# What to do when opening Lazygit outside of a git repo.
560-
# - 'prompt': (default) ask whether to initialize a new repo or open in
561-
# the most recent repo
506+
# - 'prompt': (default) ask whether to initialize a new repo or open in the most recent repo
562507
# - 'create': initialize a new repo
563508
# - 'skip': open most recent repo
564509
# - 'quit': exit Lazygit
565510
notARepository: prompt
566511

567-
# If true, display a confirmation when subprocess terminates. This allows
568-
# you to view the output of the subprocess before returning to Lazygit.
512+
# If true, display a confirmation when subprocess terminates. This allows you to view the output of the subprocess before returning to Lazygit.
569513
promptToReturnFromSubprocess: true
570514

571515
# Keybindings

0 commit comments

Comments
 (0)