Skip to content
This repository was archived by the owner on May 1, 2024. It is now read-only.

Commit 44c3178

Browse files
committed
cake.config comments and formatting added
1 parent 496a937 commit 44c3178

File tree

1 file changed

+48
-7
lines changed

1 file changed

+48
-7
lines changed

cake.config

+48-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
; The configuration file for Cake.
22

3+
;-------------------------------------------------------------------------------
34
; NuGet Download Url
45
; This allows the control of where Cake downloads NuGet packages from when
56
; using the addin and tool preprocessor directives. This can be useful when
@@ -8,79 +9,119 @@
89
;
910
; Default Value
1011
; https://packages.nuget.org/api/v2
12+
1113
; Environment Variable Name
1214
; CAKE_NUGET_SOURCE
15+
1316
; ini File Contents
1417
; [Nuget]
1518
; Source=http://myfeed/nuget/
19+
1620
; Direct Argument
1721
; cake.exe --nuget_source=http://myfeed/nuget/
1822

1923

24+
;-------------------------------------------------------------------------------
2025
; Roslyn NuGet Download Url
2126
; This allows the control of where Cake downloads the required Roslyn NuGet
22-
; packages. This can be useful when it is necessary to work in an offline mode, where direct access to nuget.org is not available.
27+
; packages. This can be useful when it is necessary to work in an offline mode,
28+
; where direct access to nuget.org is not available.
2329
;
2430
; Default Value
2531
; https://packages.nuget.org/api/v2
32+
2633
; Environment Variable Name
2734
; CAKE_ROSLYN_NUGETSOURCE
35+
2836
; ini File Contents
2937
; [Roslyn]
3038
; NuGetSource=https://mycustomurl
39+
3140
; Direct Argument
3241
; cake.exe --roslyn_nugetsource=http://mycustomurl
3342

3443

44+
;-------------------------------------------------------------------------------
3545
; Tools Path
36-
; This allows the configuration of the tools folder which is used by Cake when restoring tools.
46+
; This allows the configuration of the tools folder which is used by Cake when
47+
; restoring tools.
3748
;
3849
; Default Value
3950
; ./tools
4051
; Environment Variable Name
4152
; CAKE_PATHS_TOOLS
53+
4254
; ini File Contents
4355
; [Paths]
4456
; Tools=./tools
57+
4558
; Direct Argument
4659
; cake.exe --paths_tools=./tools
60+
61+
;-------------------------------------------------------------------------------
4762
; Addins Path
48-
; This allows the configuration of the Addins folder which is used by Cake when restoring Addins.
63+
; This allows the configuration of the Addins folder which is used by Cake when
64+
; restoring Addins.
4965
;
5066
; Default Value
5167
; ./tools/Addins
68+
5269
; Environment Variable Name
5370
; CAKE_PATHS_ADDINS
71+
5472
; ini File Contents
5573
; [Paths]
5674
; Addins=./tools/Addins
75+
5776
; Direct Argument
5877
; cake.exe --paths_addins=./tools/Addins
78+
79+
80+
;-------------------------------------------------------------------------------
5981
; Modules Path
60-
; This allows the configuration of the Modules folder which is used by Cake when loading custom Modules.
82+
; This allows the configuration of the Modules folder which is used by Cake when
83+
; loading custom Modules.
6184
;
6285
; Default Value
6386
; ./tools/Modules
87+
6488
; Environment Variable Name
6589
; CAKE_PATHS_MODULES
90+
6691
; ini File Contents
6792
; [Paths]
6893
; Modules=./tools/Modules
94+
6995
; Direct Argument
7096
; cake.exe --paths_modules=./tools/Modules
97+
98+
99+
;-------------------------------------------------------------------------------
71100
; Skip Verification
72-
; If any breaking changes are introduced to Cake, we'll set the minimum supported version of the Cake.Core assembly, any addin/assembly that references an older version of Cake.Core will generate an exception and ultimately abort the execution of the script. This is to avoid runtime errors during execution of the script.
101+
; If any breaking changes are introduced to Cake, we'll set the minimum supported
102+
; version of the Cake.Core assembly, any addin/assembly that references an older
103+
; version of Cake.Core will generate an exception and ultimately abort the
104+
; execution of the script. This is to avoid runtime errors during execution of the
105+
; script.
73106
;
74-
; But if you really need to use an addin/assembly and have verified that the breaking change introduced doesn't concern the addin/assembly directly, i.e. it doesn't use a removed property or changed interface, for this scenario we'll allow you to temporarily opt-out of the assembly verification until addin/assembly author has released a version of the assembly targeting the minimum required version of Cake.Core.
107+
; But if you really need to use an addin/assembly and have verified that the breaking
108+
; change introduced doesn't concern the addin/assembly directly, i.e. it doesn't use
109+
; a removed property or changed interface, for this scenario we'll allow you to
110+
; temporarily opt-out of the assembly verification until addin/assembly author has
111+
; released a version of the assembly targeting the minimum required version of
112+
; Cake.Core.
75113
;
76-
; A word of caution, this setting is global for all addins/assemblies your script references and should therefore be considered a temporary quick fix.
114+
; A word of caution, this setting is global for all addins/assemblies your script
115+
; references and should therefore be considered a temporary quick fix.
77116
;
78117
; Default Value
79118
; false
119+
80120
; Valid Values
81121
; true
82122
; or
83123
; false
124+
84125
; Environment Variable Name
85126
; CAKE_SETTINGS_SKIPVERIFICATION
86127

0 commit comments

Comments
 (0)