This is an archive of the discontinued LLVM Phabricator instance.

[Doc] Update LangRef for new Module Flag Behavior
ClosedPublic

Authored by steven_wu on Aug 9 2017, 4:17 PM.

Reviewers

Commits

Summary

Add the documentation for the new module flag behavior. The new
ModFlagBehavior is added in r303590.

LGTM, thanks!

This revision is now accepted and ready to land.Aug 15 2017, 6:56 AM

This revision was automatically updated to reflect the committed changes.

+ Hans

Should we also add this doc update to 5.0 branch?

In D36557#842159, @steven_wu wrote:

+ Hans

Should we also add this doc update to 5.0 branch?

Yes, thanks for letting me know. I've merged it to 5.0 in

Path

Size

llvm/

trunk/

docs/

4 lines

Show First 20 Lines • Show All 5,372 Lines • ▼ Show 20 Lines	- Append
Appends the two values, which are required to be metadata nodes.		Appends the two values, which are required to be metadata nodes.

* - 6		* - 6
- AppendUnique		- AppendUnique
Appends the two values, which are required to be metadata		Appends the two values, which are required to be metadata
nodes. However, duplicate entries in the second list are dropped		nodes. However, duplicate entries in the second list are dropped
during the append operation.		during the append operation.

		* - 7
		- Max
		Takes the max of the two values, which are required to be integers.

It is an error for a particular unique flag ID to have multiple behaviors,		It is an error for a particular unique flag ID to have multiple behaviors,
except in the case of Require (which adds restrictions on another metadata		except in the case of Require (which adds restrictions on another metadata
value) or Override.		value) or Override.

An example of module flags:		An example of module flags:

.. code-block:: llvm		.. code-block:: llvm

▲ Show 20 Lines • Show All 8,956 Lines • Show Last 20 Lines