Skip to content

Commit 60d953a

Browse files
mairawmairaw
authored
fixing json config (dotnet#1009)
* fixing json config * fix future tense * addressed feedback * Fixing emitEntryPoint description Also fencing the code block
1 parent 59cb2f6 commit 60d953a

File tree

2 files changed

+110
-111
lines changed

2 files changed

+110
-111
lines changed

‎docs/core/tools/dotnet-build.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ dotnet-build -- Builds a project and all of its dependencies
2929
## DESCRIPTION
3030

3131
The `dotnet build` command builds multiple source file from a source project and its dependencies into a binary.
32-
The binary will be in Intermediate Language (IL) by default and will have a DLL extension.
33-
`dotnet build` will also drop a `\*.deps` file which outlines what the host needs to run the application.
32+
By default, the resulting binary is in Intermediate Language (IL) and has a DLL extension.
33+
`dotnet build` also drops a `\*.deps` file which outlines what the host needs to run the application.
3434

3535
Building requires the existence of a lock file, which means that you have to run [`dotnet restore`](dotnet-restore.md) prior to building your code.
3636

37-
Before any compilation begins, the build verb analyzes the project and its dependencies for incremental safety checks.
37+
Before any compilation begins, the `build` verb analyzes the project and its dependencies for incremental safety checks.
3838
If all checks pass, then build proceeds with incremental compilation of the project and its dependencies;
3939
otherwise, it falls back to non-incremental compilation. Via a profile flag, users can choose to receive additional
4040
information on how they can improve their build times.
@@ -45,11 +45,11 @@ compilation process to be incremental:
4545
- not load compilation tools from PATH (for example, resgen, compilers)
4646
- use only known compilers (csc, vbc, fsc)
4747

48-
In order to build an executable application, you need a special configuration section in your project.json file:
48+
In order to build an executable application instead of a library, you need a [special configuration](project-json.md#emitentrypoint) section in your project.json file:
4949

5050
```json
5151
{
52-
"compilerOptions": {
52+
"buildOptions": {
5353
"emitEntryPoint": true
5454
}
5555
}

‎docs/core/tools/project-json.md

Lines changed: 105 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -14,126 +14,125 @@ ms.assetid: 3aef32bd-ee2a-4e24-80f8-a2b615e0336d
1414

1515
# project.json reference
1616

17-
> [!NOTE]
18-
> This topic is preliminary and subject to change in the next release. You can track the status of this issue through our public GitHub issue tracker.
19-
2017
## Overview
2118

22-
{
23-
"name": String,
24-
"version": String,
25-
"description": String,
26-
"copyright": String,
27-
"title": String,
28-
"entryPoint": String,
29-
"testRunner": String,
30-
"authors": String[],
31-
"language": String,
32-
"embedInteropTypes": Boolean,
33-
"preprocess": String or String[],
34-
"shared": String or String[],
35-
"dependencies": Object,
36-
"tools": Object,
37-
"scripts": Object,
38-
"buildOptions": Object {
39-
"define": String[],
40-
"nowarn": String[],
41-
"additionalArguments": String[],
42-
"warningsAsErrors": Boolean,
43-
"allowUnsafe": Boolean,
44-
"emitEntryPoint": Boolean,
45-
"optimize": Boolean,
46-
"platform": String,
47-
"languageVersion": String,
48-
"keyFile": String,
49-
"delaySign": Boolean,
50-
"publicSign": Boolean,
51-
"debugType": String,
52-
"xmlDoc": Boolean,
53-
"preserveCompilationContext": Boolean,
54-
"outputName": String,
55-
"compilerName": String,
56-
"compile": Object {
57-
"include": String or String[],
58-
"exclude": String or String[],
59-
"includeFiles": String or String[],
60-
"excludeFiles": String or String[],
61-
"builtIns": Object,
62-
"mappings": Object
63-
},
64-
"embed": Object {
65-
"include": String or String[],
66-
"exclude": String or String[],
67-
"includeFiles": String or String[],
68-
"excludeFiles": String or String[],
69-
"builtIns": Object,
70-
"mappings": Object
71-
},
72-
"copyToOutput": Object {
73-
"include": String or String[],
74-
"exclude": String or String[],
75-
"includeFiles": String or String[],
76-
"excludeFiles": String or String[],
77-
"builtIns": Object,
78-
"mappings": Object
79-
}
19+
```
20+
{
21+
"name": String,
22+
"version": String,
23+
"description": String,
24+
"copyright": String,
25+
"title": String,
26+
"entryPoint": String,
27+
"testRunner": String,
28+
"authors": String[],
29+
"language": String,
30+
"embedInteropTypes": Boolean,
31+
"preprocess": String or String[],
32+
"shared": String or String[],
33+
"dependencies": Object,
34+
"tools": Object,
35+
"scripts": Object,
36+
"buildOptions": Object {
37+
"define": String[],
38+
"nowarn": String[],
39+
"additionalArguments": String[],
40+
"warningsAsErrors": Boolean,
41+
"allowUnsafe": Boolean,
42+
"emitEntryPoint": Boolean,
43+
"optimize": Boolean,
44+
"platform": String,
45+
"languageVersion": String,
46+
"keyFile": String,
47+
"delaySign": Boolean,
48+
"publicSign": Boolean,
49+
"debugType": String,
50+
"xmlDoc": Boolean,
51+
"preserveCompilationContext": Boolean,
52+
"outputName": String,
53+
"compilerName": String,
54+
"compile": Object {
55+
"include": String or String[],
56+
"exclude": String or String[],
57+
"includeFiles": String or String[],
58+
"excludeFiles": String or String[],
59+
"builtIns": Object,
60+
"mappings": Object
8061
},
81-
"publishOptions": Object {
62+
"embed": Object {
8263
"include": String or String[],
8364
"exclude": String or String[],
8465
"includeFiles": String or String[],
8566
"excludeFiles": String or String[],
8667
"builtIns": Object,
8768
"mappings": Object
8869
},
89-
"runtimeOptions": Object {
90-
"configProperties": Object {
91-
"System.GC.Server": Boolean,
92-
"System.GC.Concurrent": Boolean,
93-
"System.GC.RetainVM": Boolean,
94-
"System.Threading.ThreadPool.MinThreads": Integer,
95-
"System.Threading.ThreadPool.MaxThreads": Integer
96-
},
97-
"framework": Object {
98-
"name": String,
99-
"version": String,
100-
},
101-
"applyPatches": Boolean
70+
"copyToOutput": Object {
71+
"include": String or String[],
72+
"exclude": String or String[],
73+
"includeFiles": String or String[],
74+
"excludeFiles": String or String[],
75+
"builtIns": Object,
76+
"mappings": Object
77+
}
78+
},
79+
"publishOptions": Object {
80+
"include": String or String[],
81+
"exclude": String or String[],
82+
"includeFiles": String or String[],
83+
"excludeFiles": String or String[],
84+
"builtIns": Object,
85+
"mappings": Object
86+
},
87+
"runtimeOptions": Object {
88+
"configProperties": Object {
89+
"System.GC.Server": Boolean,
90+
"System.GC.Concurrent": Boolean,
91+
"System.GC.RetainVM": Boolean,
92+
"System.Threading.ThreadPool.MinThreads": Integer,
93+
"System.Threading.ThreadPool.MaxThreads": Integer
10294
},
103-
"packOptions": Object {
104-
"summary": String,
105-
"tags": String[],
106-
"owners": String[],
107-
"releaseNotes": String,
108-
"iconUrl": String,
109-
"projectUrl": String,
110-
"licenseUrl": String,
111-
"requireLicenseAcceptance": Boolean,
112-
"repository": Object {
113-
"type": String,
114-
"url": String
115-
},
116-
"files": Object {
117-
"include": String or String[],
118-
"exclude": String or String[],
119-
"includeFiles": String or String[],
120-
"excludeFiles": String or String[],
121-
"builtIns": Object,
122-
"mappings": Object
123-
}
95+
"framework": Object {
96+
"name": String,
97+
"version": String,
12498
},
125-
"analyzerOptions": Object {
126-
"languageId": String
99+
"applyPatches": Boolean
100+
},
101+
"packOptions": Object {
102+
"summary": String,
103+
"tags": String[],
104+
"owners": String[],
105+
"releaseNotes": String,
106+
"iconUrl": String,
107+
"projectUrl": String,
108+
"licenseUrl": String,
109+
"requireLicenseAcceptance": Boolean,
110+
"repository": Object {
111+
"type": String,
112+
"url": String
127113
},
128-
"configurations": Object,
129-
"frameworks": Object {
130-
"dependencies": Object,
131-
"frameworkAssemblies": Object,
132-
"wrappedProject": String,
133-
"bin": Object,
134-
"imports": String
114+
"files": Object {
115+
"include": String or String[],
116+
"exclude": String or String[],
117+
"includeFiles": String or String[],
118+
"excludeFiles": String or String[],
119+
"builtIns": Object,
120+
"mappings": Object
135121
}
122+
},
123+
"analyzerOptions": Object {
124+
"languageId": String
125+
},
126+
"configurations": Object,
127+
"frameworks": Object {
128+
"dependencies": Object,
129+
"frameworkAssemblies": Object,
130+
"wrappedProject": String,
131+
"bin": Object,
132+
"imports": String
136133
}
134+
}
135+
```
137136

138137
## name
139138
Type: String
@@ -443,7 +442,7 @@ For example:
443442
### emitEntryPoint
444443
Type: Boolean
445444

446-
`true` to create an executable; `false` to produce a `.dll` file. The default is `false`.
445+
`true` to create an executable; `false` to produce a library. The default is `false`.
447446

448447
For example:
449448

0 commit comments

Comments
 (0)