Skip to content

Commit c192106

Browse files
author
Colin Robertson
committed
Acrolinx pass
1 parent d235736 commit c192106

12 files changed

+155
-151
lines changed

docs/assembler/arm/arm-assembler-command-line-reference.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,65 @@ ms.assetid: f7b89478-1ab5-4995-8cde-a805f0462c45
66
---
77
# ARM Assembler command-line reference
88

9-
This article provides command-line information about the Microsoft ARM assembler, *armasm*, which compiles ARMv7 Thumb assembly language into the Microsoft implementation of the Common Object File Format (COFF). The linker can link COFF code with object code that is produced by the ARM assembler or by the C compiler, together with object libraries that are created by the librarian.
9+
This article provides command-line information about the Microsoft ARM assembler, **armasm**. **armasm** assembles ARMv7 Thumb assembly language into the Microsoft implementation of the Common Object File Format (COFF). The linker can link COFF code objects produced by both the ARM assembler and the C compiler. It can link either together with object libraries created by the librarian.
1010

1111
## Syntax
1212

13-
> **armasm** [*options*] *sourcefile* *objectfile*
14-
> **armasm** [*options*] **-o** *objectfile* *sourcefile*
13+
> **`armasm`** [*options*] *source_file* *object_file*\
14+
> **`armasm`** [*options*] **`-o`** *object_file* *source_file*
1515
1616
### Parameters
1717

18-
*options*<br/>
19-
A combination of zero or more of the following:
18+
*options*\
19+
A combination of zero or more of the following options:
2020

21-
- **-errors** *filename*<br/>
21+
- **`-errors`** *filename*\
2222
Redirect error and warning messages to *filename*.
2323

24-
- **-i** *dir*[**;**<em>dir</em>]<br/>
24+
- **`-i`** *dir*[**`;`**<em>dir</em>]\
2525
Add the specified directories to the include search path.
2626

27-
- **-predefine** *directive*<br/>
28-
Specify a SETA, SETL, or SETS directive to predefine a symbol.<br/>
29-
Example: **armasm.exe -predefine "COUNT SETA 150" source.asm**<br/>
27+
- **`-predefine`** *directive*\
28+
Specify a SETA, SETL, or SETS directive to predefine a symbol.\
29+
Example: `armasm.exe -predefine "COUNT SETA 150" source.asm`\
3030
For more information, see the [ARM Compiler armasm Reference Guide](http://infocenter.arm.com/help/topic/com.arm.doc.dui0802b/index.html).
3131

32-
- **-nowarn**<br/>
32+
- **`-nowarn`**\
3333
Disable all warning messages.
3434

35-
- **-ignore** *warning*<br/>
35+
- **`-ignore`** *warning*\
3636
Disable the specified warning. For possible values, see the section about warnings.
3737

38-
- **-help**<br/>
38+
- **`-help`**\
3939
Print the command-line help message.
4040

41-
- **-machine** *machine*<br/>
42-
Specify the machine type to set in the PE header. Possible values for *machine* are:<br/>
43-
**ARM**—Sets the machine type to IMAGE_FILE_MACHINE_ARMNT. This is the default.<br/>
41+
- **`-machine`** *machine*\
42+
Specify the machine type to set in the PE header. Possible values for *machine* are:\
43+
**ARM**—Sets the machine type to IMAGE_FILE_MACHINE_ARMNT. This option is the default.\
4444
**THUMB**—Sets the machine type to IMAGE_FILE_MACHINE_THUMB.
4545

46-
- **-oldit**<br/>
46+
- **`-oldit`**\
4747
Generate ARMv7-style IT blocks. By default, ARMv8-compatible IT blocks are generated.
4848

49-
- **-via** *filename*<br/>
49+
- **`-via`** *filename*\
5050
Read additional command-line arguments from *filename*.
5151

52-
- **-16**<br/>
53-
Assemble source as 16-bit Thumb instructions. This is the default.
52+
- **`-16`**\
53+
Assemble source as 16-bit Thumb instructions. This option is the default.
5454

55-
- **-32**<br/>
55+
- **`-32`**\
5656
Assemble source as 32-bit ARM instructions.
5757

58-
- **-g**<br/>
58+
- **`-g`**\
5959
Generate debugging information.
6060

61-
- **-errorReport:** *option*<br/>
61+
- **`-errorReport:`** *option*\
6262
This option is deprecated, and has no effect. Starting in Windows Vista, error reporting is controlled by [Windows Error Reporting (WER)](/windows/win32/wer/windows-error-reporting) settings.
6363

64-
*sourcefile*<br/>
64+
*source_file*\
6565
The name of the source file.
6666

67-
*objectfile*<br/>
67+
*object_file*\
6868
The name of the object (output) file.
6969

7070
## Remarks
@@ -78,5 +78,5 @@ cl myccode.c /link myasmcode.obj
7878

7979
## See also
8080

81-
[ARM Assembler Diagnostic Messages](../../assembler/arm/arm-assembler-diagnostic-messages.md)<br/>
82-
[ARM Assembler Directives](../../assembler/arm/arm-assembler-directives.md)
81+
[ARM Assembler diagnostic messages](../../assembler/arm/arm-assembler-diagnostic-messages.md)\
82+
[ARM Assembler directives](../../assembler/arm/arm-assembler-directives.md)

docs/assembler/masm/ml-and-ml64-command-line-reference.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ ms.assetid: 712623c6-f77e-47ea-a945-089e57c50b40
88
---
99
# ML and ML64 command-line reference
1010

11-
Assembles and links one or more assembly-language source files. The command-line options are case sensitive.
11+
Assembles and links one or more assembly-language source files. The command-line options are case-sensitive.
1212

1313
For more information on ml64.exe, see [MASM for x64 (ml64.exe)](masm-for-x64-ml64-exe.md).
1414

1515
## Syntax
1616

1717
> ML \[*options*] *filename* \[ \[*options*] *filename*]
1818
>
19-
> ML64 \[*options*] *filename* \[ \[*options*] *filename*] ... \[/link *linkoptions*]
19+
> ML64 \[*options*] *filename* \[ \[*options*] *filename*] ... \[/link *link_options*]
2020
2121
### Parameters
2222

@@ -25,21 +25,21 @@ The options listed in the following table.
2525

2626
|Option|Action|
2727
|------------|------------|
28-
|**/AT**|Enables tiny-memory-model support. Enables error messages for code constructs that violate the requirements for .com format files. Note that this is not equivalent to the [.MODEL](dot-model.md) **TINY** directive.<br /><br /> Not available in ml64.exe.|
28+
|**/AT**|Enables tiny-memory-model support. Enables error messages for code constructs that violate the requirements for .com format files. This option isn't equivalent to the [.MODEL](dot-model.md) **TINY** directive.<br /><br /> Not available in ml64.exe.|
2929
|**/Bl** *filename*|Selects an alternate linker.|
30-
|**/c**|Assembles only. Does not link.|
31-
|**/coff**|Generates common object file format (COFF) type of object module. Generally required for Win32 assembly language development.<br /><br /> Not available in ml64.exe.|
30+
|**/c**|Assembles only. Does no linking.|
31+
|**/coff**|Generates common object file format (COFF) type of object module. Required for Win32 assembly language development.<br /><br /> Not available in ml64.exe.|
3232
|**/Cp**|Preserves case of all user identifiers.|
3333
|**/Cu**|Maps all identifiers to upper case (default).<br /><br /> Not available in ml64.exe.|
3434
|**/Cx**|Preserves case in public and extern symbols.|
35-
|**/D** *symbol*⟦=*value*|Defines a text macro with the given name. If *value* is missing, it is blank. Multiple tokens separated by spaces must be enclosed in quotation marks.|
35+
|**/D** *symbol*⟦=*value*|Defines a text macro with the given name. If *value* is missing, it's blank. Multiple tokens separated by spaces must be enclosed in quotation marks.|
3636
|**/EP**|Generates a preprocessed source listing (sent to STDOUT). See **/Sf**.|
3737
|**/ERRORREPORT** [ **NONE** &#124; **PROMPT** &#124; **QUEUE** &#124; **SEND** ]| Deprecated. Error reporting is controlled by [Windows Error Reporting (WER)](/windows/win32/wer/windows-error-reporting) settings. |
38-
|**/F** *hexnum*|Sets stack size to *hexnum* bytes (this is the same as **/link/STACK**:*number*). The value must be expressed in hexadecimal notation. There must be a space between **/F** and *hexnum*.|
38+
|**/F** *hexnum*|Sets stack size to *hexnum* bytes (the same as **/link /STACK**:*number*). The value must be expressed in hexadecimal notation. There must be a space between **/F** and *hexnum*.|
3939
|**/Fe** *filename*|Names the executable file.|
4040
|**/Fl***filename*|Generates an assembled code listing. See **/Sf**.|
4141
|**/Fm***filename*|Creates a linker map file.|
42-
|**/Fo** *filename*|Names an object file. See Remarks section for more information.|
42+
|**/Fo** *filename*|Names an object file. For more information, see [Remarks](#remarks).|
4343
|**/FPi**|Generates emulator fix-ups for floating-point arithmetic (mixed language only).<br /><br /> Not available in ml64.exe.|
4444
|**/Fr***filename*|Generates a source browser .sbr file.|
4545
|**/FR***filename*|Generates an extended form of a source browser .sbr file.|
@@ -50,7 +50,7 @@ The options listed in the following table.
5050
|**/help**|Calls QuickHelp for help on ML.|
5151
|**/I** *pathname*|Sets path for include file. A maximum of 10 **/I** options is allowed.|
5252
|**/nologo**|Suppresses messages for successful assembly.|
53-
|**/omf**|Generates object module file format (OMF) type of object module. **/omf** implies **/c**; ML.exe does not support linking OMF objects.<br /><br /> Not available in ml64.exe.|
53+
|**/omf**|Generates object module file format (OMF) type of object module. **/omf** implies **/c**; ML.exe doesn't support linking OMF objects.<br /><br /> Not available in ml64.exe.|
5454
|**/Sa**|Turns on listing of all available information.|
5555
|**/safeseh**|Marks the object as either containing no exception handlers or containing exception handlers that are all declared with [.SAFESEH](dot-safeseh.md).<br /><br /> Not available in ml64.exe.|
5656
|**/Sf**|Adds first-pass listing to listing file.|
@@ -60,7 +60,7 @@ The options listed in the following table.
6060
|**/Ss** *text*|Specifies text for source listing. Same as [SUBTITLE](subtitle.md) text.|
6161
|**/St** *text*|Specifies title for source listing. Same as [TITLE](title.md) text.|
6262
|**/Sx**|Turns on false conditionals in listing.|
63-
|**/Ta** *filename*|Assembles source file whose name does not end with the .asm extension.|
63+
|**/Ta** *filename*|Assembles source file whose name doesn't end with the .asm extension.|
6464
|**/w**|Same as **/W0/WX**.|
6565
|**/W** *level*|Sets the warning level, where *level* = 0, 1, 2, or 3.|
6666
|**/WX**|Returns an error code if warnings are generated.|
@@ -76,14 +76,16 @@ The options listed in the following table.
7676
*filename*\
7777
The name of the file.
7878

79-
*linkoptions*\
80-
The link options. See [Linker Options](../../build/reference/linker-options.md) for more information.
79+
*link_options*\
80+
The link options. For more information, see [Linker options](../../build/reference/linker-options.md).
8181

8282
## Remarks
8383

8484
Some command-line options to ML and ML64 are placement-sensitive. For example, because ML and ML64 can accept several **/c** options, any corresponding **/Fo** options must be specified before **/c**. The following command-line example illustrates an object file specification for each assembly file specification:
8585

86-
**ml.exe /Fo a1.obj /c a.asm /Fo b1.obj /c b.asm**
86+
```cmd
87+
ml.exe /Fo a1.obj /c a.asm /Fo b1.obj /c b.asm
88+
```
8789

8890
## Environment Variables
8991

docs/build/reference/bscmake-options.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,26 @@ ms.assetid: fa2f1e06-c684-41cf-80dd-6a554835ebd2
99
# BSCMAKE Options
1010

1111
> [!WARNING]
12-
> Although BSCMAKE is still installed with Visual Studio, it is no longer used by the IDE. Since Visual Studio 2008, browse and symbol information is stored automatically in a SQL Server .sdf file in the solution folder.
12+
> Although BSCMAKE is still installed with Visual Studio, it is no longer used by the IDE. Since Visual Studio 2008, browse and symbol information is stored automatically in a SQL Server *`.sdf`* file in the solution folder.
1313
14-
This section describes the options available for controlling BSCMAKE. Several options control the content of the browse information file by excluding or including certain information. The exclusion options can allow BSCMAKE to run faster and may result in a smaller .bsc file. Option names are case sensitive (except for **/HELP** and **/NOLOGO**).
14+
This section describes the options available for controlling BSCMAKE. Several options control the content of the browse information file by excluding or including certain information. The exclusion options can allow BSCMAKE to run faster and may result in a smaller *`.bsc`* file. Option names are case-sensitive (except for **/HELP** and **/NOLOGO**).
1515

1616
Only **/NOLOGO** and **/o** are available from within the Visual Studio development environment. See [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md) for information on access a project's property pages.
1717

18-
**/Ei (** *filename*...**)**\
19-
Excludes the contents of the specified include files from the browse information file. To specify multiple files, separate the names with a space and enclose the list in parentheses. Parentheses are not necessary if you specify only one *filename*. Use **/Ei** along with the **/Es** option to exclude files not excluded by **/Es**.
18+
**/Ei (**_filename_...**)**\
19+
Excludes the contents of the specified include files from the browse information file. To specify multiple files, separate the names with a space and enclose the list in parentheses. Parentheses aren't necessary if you specify only one *filename*. Use **/Ei** along with the **/Es** option to exclude files not excluded by **/Es**.
2020

2121
**/El**\
2222
Excludes local symbols. The default is to include local symbols. For more information about local symbols, see [Creating an .sbr File](creating-an-dot-sbr-file.md).
2323

2424
**/Em**\
2525
Excludes symbols in the body of macros. Use **/Em** to include only the names of macros in the browse information file. The default is to include both the macro names and the result of the macro expansions.
2626

27-
**/Er (** *symbol*...**)**\
28-
Excludes the specified symbols from the browse information file. To specify multiple symbol names, separate the names with a space and enclose the list in parentheses. Parentheses are not necessary if you specify only one *symbol*.
27+
**/Er (**_symbol_...**)**\
28+
Excludes the specified symbols from the browse information file. To specify multiple symbol names, separate the names with a space and enclose the list in parentheses. Parentheses are unnecessary if you specify only one *symbol*.
2929

3030
**/Es**\
31-
Excludes from the browse information file every include file specified with an absolute path or found in an absolute path specified in the INCLUDE environment variable. (Usually, these are the system include files, which contain a lot of information that you may not need in your browse information file.) This option does not exclude files specified without a path or with relative paths or files found in a relative path in INCLUDE. You can use the **/Ei** option along with **/Es** to exclude files that **/Es** does not exclude. If you want to exclude only some of the files that **/Es** excludes, use **/Ei** instead of **/Es** and list the files you want to exclude.
31+
Excludes every include file specified with an absolute path, or found in an absolute path specified in the INCLUDE environment variable. (Usually, these files are the system include files, which contain much information you may not need in your browse information file.) This option doesn't exclude files specified without a path, or with relative paths, or files found in a relative path in INCLUDE. You can use the **/Ei** option along with **/Es** to exclude files that **/Es** doesn't exclude. If you want to exclude only some of the files, use **/Ei** instead of **/Es**, and list the files you want to exclude.
3232

3333
**/errorreport:**[**none** &#124; **prompt** &#124; **queue** &#124; **send**]\
3434
This option is deprecated, and has no effect. Starting in Windows Vista, error reporting is controlled by [Windows Error Reporting (WER)](/windows/win32/wer/windows-error-reporting) settings.
@@ -37,27 +37,27 @@ This option is deprecated, and has no effect. Starting in Windows Vista, error r
3737
Displays a summary of the BSCMAKE command-line syntax.
3838

3939
**/Iu**\
40-
Includes unreferenced symbols. By default, BSCMAKE does not record any symbols that are defined but not referenced. If an .sbr file has been packed, this option has no effect for that input file because the compiler has already removed the unreferenced symbols.
40+
Includes unreferenced symbols. By default, BSCMAKE doesn't record any symbols that are defined but not referenced. If an *`.sbr`* file has been packed, this option has no effect for that input file because the compiler has already removed the unreferenced symbols.
4141

4242
**/n**\
43-
Forces a nonincremental build. Use **/n** to force a full build of the browse information file whether or not a .bsc file exists and to prevent .sbr files from being truncated. See [How BSCMAKE Builds a .bsc File](how-bscmake-builds-a-dot-bsc-file.md).
43+
Forces a nonincremental build. Use **/n** to force a full build of the browse information file whether a *`.bsc`* file exists or not, and to prevent *`.sbr`* files from being truncated. See [How BSCMAKE Builds a .bsc File](how-bscmake-builds-a-dot-bsc-file.md).
4444

4545
**/NOLOGO**\
4646
Suppresses the BSCMAKE copyright message.
4747

4848
**/o** *filename*\
49-
Specifies a name for the browse information file. By default, BSCMAKE gives the browse information file the base name of the first .sbr file and a .bsc extension.
49+
Specifies a name for the browse information file. By default, BSCMAKE gives the browse information file the base name of the first *`.sbr`* file and a *`.bsc`* extension.
5050

51-
**/S (** *filename*...**)**\
52-
Tells BSCMAKE to process the specified include file the first time it is encountered and to exclude it otherwise. Use this option to save processing time when a file (such as a header, or .h, file for a .c or .cpp source file) is included in several source files but is unchanged by preprocessing directives each time. You may also want to use this option if a file is changed in ways that are unimportant for the browse information file you are creating. To specify multiple files, separate the names with a space and enclose the list in parentheses. Parentheses are not necessary if you specify only one *filename*. If you want to exclude the file every time it is included, use the **/Ei** or **/Es** option.
51+
**/S (**_filename_...**)**\
52+
Tells BSCMAKE to process the specified include file the first time it's encountered and to exclude it otherwise. Use this option to save processing time when a file (such as a header, or *`.h`*, file for a *`.c`* or *`.cpp`* source file) is included in several source files but is unchanged by preprocessing directives each time. Use this option if a file is changed in ways unimportant for the browse information file you're creating. To specify multiple files, separate the names with a space, and enclose the list in parentheses. Parentheses aren't necessary if you specify only one *filename*. If you want to exclude the file every time it's included, use the **/Ei** or **/Es** option.
5353

5454
**/v**\
55-
Provides verbose output, which includes the name of each .sbr file being processed and information about the complete BSCMAKE run.
55+
Provides verbose output, which includes the name of each *`.sbr`* file being processed and information about the complete BSCMAKE run.
5656

5757
**/?**\
5858
Displays a brief summary of BSCMAKE command-line syntax.
5959

60-
The following command line tells BSCMAKE to do a full build of MAIN.bsc from three .sbr files. It also tells BSCMAKE to exclude duplicate instances of TOOLBOX.h:
60+
The following command line tells BSCMAKE to do a full build of MAIN.bsc from three *`.sbr`* files. It also tells BSCMAKE to exclude duplicate instances of TOOLBOX.h:
6161

6262
```cmd
6363
BSCMAKE /n /S toolbox.h /o main.bsc file1.sbr file2.sbr file3.sbr

0 commit comments

Comments
 (0)