This is an archive of the discontinued LLVM Phabricator instance.

Fix a few typos and run-on sentences in the clang POD documentation.
ClosedPublic

Authored by gaeke on Jun 4 2015, 12:03 AM.

Download Raw Diff

Details

Reviewers

mclow.lists
compnerd

Diff Detail

Event Timeline

gaeke updated this revision to Diff 27094.Jun 4 2015, 12:03 AM

gaeke retitled this revision from to Fix a few typos and run-on sentences in the clang POD documentation..

gaeke updated this object.

gaeke edited the test plan for this revision. (Show Details)

gaeke added a subscriber: Unknown Object (MLST).Jun 4 2015, 12:03 AM

gaeke set the repository for this revision to rL LLVM.Jun 4 2015, 12:10 AM

majnemer added a subscriber: majnemer.Jun 12 2015, 4:41 PM

majnemer added inline comments.

docs/tools/clang.pod
392	I think this would read better as: Don't emit any warnings for unused driver arguments.

gaeke added a reviewer: compnerd.Jun 12 2015, 4:42 PM

gaeke added inline comments.

docs/tools/clang.pod
392	Agreed. I will make this change.

Apply majnemer's edit to the description of -Qunused-arguments.

LGTM.

docs/tools/clang.pod
392	Could just be "Do not emit warnings for unused driver arguments" Either way is OK, I think - but use "Do not" instead of don't.

This revision is now accepted and ready to land.Jun 12 2015, 5:05 PM

Use "Do not" instead of "don't" as suggested by mclow.

Committed as SVN r239652. Thanks!

Revision Contents

Path

Size

docs/

tools/

clang.pod

14 lines

Diff 27618

docs/tools/clang.pod

	Show All 33 Lines
	you do not need to interact with the driver, but you transparently use it to run			you do not need to interact with the driver, but you transparently use it to run
	the other tools.			the other tools.

	=item B<Preprocessing>			=item B<Preprocessing>

	This stage handles tokenization of the input source file, macro expansion,			This stage handles tokenization of the input source file, macro expansion,
	#include expansion and handling of other preprocessor directives. The output of			#include expansion and handling of other preprocessor directives. The output of
	this stage is typically called a ".i" (for C), ".ii" (for C++), ".mi" (for			this stage is typically called a ".i" (for C), ".ii" (for C++), ".mi" (for
	Objective-C) , or ".mii" (for Objective-C++) file.			Objective-C), or ".mii" (for Objective-C++) file.

	=item B<Parsing and Semantic Analysis>			=item B<Parsing and Semantic Analysis>

	This stage parses the input file, translating preprocessor tokens into a parse			This stage parses the input file, translating preprocessor tokens into a parse
	tree. Once in the form of a parser tree, it applies semantic analysis to compute			tree. Once in the form of a parse tree, it applies semantic analysis to compute
	types for expressions as well and determine whether the code is well formed. This			types for expressions as well and determine whether the code is well formed. This
	stage is responsible for generating most of the compiler warnings as well as			stage is responsible for generating most of the compiler warnings as well as
	parse errors. The output of this stage is an "Abstract Syntax Tree" (AST).			parse errors. The output of this stage is an "Abstract Syntax Tree" (AST).

	=item B<Code Generation and Optimization>			=item B<Code Generation and Optimization>

	This stage translates an AST into low-level intermediate code (known as "LLVM			This stage translates an AST into low-level intermediate code (known as "LLVM
	IR") and ultimately to machine code. This phase is responsible for optimizing			IR") and ultimately to machine code. This phase is responsible for optimizing
	▲ Show 20 Lines • Show All 269 Lines • ▼ Show 20 Lines
	The B<-fstandalone-debug> option turns off these optimizations. This			The B<-fstandalone-debug> option turns off these optimizations. This
	is useful when working with 3rd-party libraries that don't come with			is useful when working with 3rd-party libraries that don't come with
	debug information. This is the default on Darwin. Note that Clang			debug information. This is the default on Darwin. Note that Clang
	will never emit type information for types that are not referenced at			will never emit type information for types that are not referenced at
	all by the program.			all by the program.

	=item B<-fexceptions>			=item B<-fexceptions>

	Enable generation of unwind information, this allows exceptions to be thrown			Enable generation of unwind information. This allows exceptions to be thrown
	through Clang compiled stack frames. This is on by default in x86-64.			through Clang compiled stack frames. This is on by default in x86-64.

	=item B<-ftrapv>			=item B<-ftrapv>

	Generate code to catch integer overflow errors. Signed integer overflow is			Generate code to catch integer overflow errors. Signed integer overflow is
	undefined in C, with this flag, extra code is generated to detect this and abort			undefined in C. With this flag, extra code is generated to detect this and abort
	when it happens.			when it happens.


	=item B<-fvisibility>			=item B<-fvisibility>

	This flag sets the default visibility level.			This flag sets the default visibility level.

	=item B<-fcommon>			=item B<-fcommon>
	Show All 36 Lines
	Print (but do not run) the commands to run for this compilation.			Print (but do not run) the commands to run for this compilation.

	=item B<--help>			=item B<--help>

	Display available options.			Display available options.

	=item B<-Qunused-arguments>			=item B<-Qunused-arguments>

	Don't emit warning for unused driver arguments.			Do not emit any warnings for unused driver arguments.
				majnemerUnsubmitted Not Done Reply Inline Actions I think this would read better as: Don't emit any warnings for unused driver arguments. majnemer: I think this would read better as: > Don't emit any warnings for unused driver arguments.
				gaekeAuthorUnsubmitted Not Done Reply Inline Actions Agreed. I will make this change. gaeke: Agreed. I will make this change.
				mclow.listsUnsubmitted Not Done Reply Inline Actions Could just be "Do not emit warnings for unused driver arguments" Either way is OK, I think - but use "Do not" instead of don't. mclow.lists: Could just be "Do not emit warnings for unused driver arguments" Either way is OK, I think…

	=item B<-Wa,>I<args>			=item B<-Wa,>I<args>

	Pass the comma separated arguments in I<args> to the assembler.			Pass the comma separated arguments in I<args> to the assembler.

	=item B<-Wl,>I<args>			=item B<-Wl,>I<args>

	Pass the comma separated arguments in I<args> to the linker.			Pass the comma separated arguments in I<args> to the linker.
	▲ Show 20 Lines • Show All 172 Lines • ▼ Show 20 Lines

	These environment variables are checked, in order, for the location to			These environment variables are checked, in order, for the location to
	write temporary files used during the compilation process.			write temporary files used during the compilation process.

	=item B<CPATH>			=item B<CPATH>

	If this environment variable is present, it is treated as a delimited			If this environment variable is present, it is treated as a delimited
	list of paths to be added to the default system include path list. The			list of paths to be added to the default system include path list. The
	delimiter is the platform dependent delimitor, as used in the I<PATH>			delimiter is the platform dependent delimiter, as used in the I<PATH>
	environment variable.			environment variable.

	Empty components in the environment variable are ignored.			Empty components in the environment variable are ignored.

	=item B<C_INCLUDE_PATH>, B<OBJC_INCLUDE_PATH>, B<CPLUS_INCLUDE_PATH>,			=item B<C_INCLUDE_PATH>, B<OBJC_INCLUDE_PATH>, B<CPLUS_INCLUDE_PATH>,
	B<OBJCPLUS_INCLUDE_PATH>			B<OBJCPLUS_INCLUDE_PATH>

	These environment variables specify additional paths, as for CPATH,			These environment variables specify additional paths, as for CPATH,
	which are only used when processing the appropriate language.			which are only used when processing the appropriate language.

	=item B<MACOSX_DEPLOYMENT_TARGET>			=item B<MACOSX_DEPLOYMENT_TARGET>

	If -mmacosx-version-min is unspecified, the default deployment target			If -mmacosx-version-min is unspecified, the default deployment target
	is read from this environment variable. This option only affects darwin			is read from this environment variable. This option only affects Darwin
	targets.			targets.

	=back			=back

	=head1 BUGS			=head1 BUGS

	To report bugs, please visit L<http://llvm.org/bugs/>. Most bug reports should			To report bugs, please visit L<http://llvm.org/bugs/>. Most bug reports should
	include preprocessed source files (use the B<-E> option) and the full output of			include preprocessed source files (use the B<-E> option) and the full output of
	Show All 11 Lines